Struct Binding 

pub struct Binding<'a> {
    pub kind: BindingKind<'a>,
    pub range: TextRange,
    pub scope: ScopeId,
    pub context: ExecutionContext,
    pub source: Option<NodeId>,
    pub references: Vec<ResolvedReferenceId>,
    pub exceptions: Exceptions,
    pub flags: BindingFlags,
}

Fields

kind: BindingKind<'a>

range: TextRange

scope: ScopeId

The ScopeId of the scope in which the Binding was defined.

context: ExecutionContext

The context in which the Binding was created.

source: Option<NodeId>

The statement in which the Binding was defined.

references: Vec<ResolvedReferenceId>

The references to the Binding.

exceptions: Exceptions

The exceptions that were handled when the Binding was defined.

flags: BindingFlags

Flags for the Binding.

Implementations

impl<'a> Binding<'a>

pub fn is_unused(&self) -> bool

Return true if this Binding is unused.

This method is the opposite of Binding::is_used.

pub fn is_used(&self) -> bool

Return true if this Binding is used.

This method is the opposite of Binding::is_unused.

pub fn references(&self) -> impl Iterator<Item = ResolvedReferenceId> + '_

Returns an iterator over all references for the current Binding.

pub const fn is_explicit_export(&self) -> bool

Return true if this Binding represents an explicit re-export (e.g., FastAPI in from fastapi import FastAPI as FastAPI).

pub const fn is_external(&self) -> bool

Return true if this Binding represents an external symbol (e.g., FastAPI in from fastapi import FastAPI).

pub const fn is_alias(&self) -> bool

Return true if this Binding represents an aliased symbol (e.g., app in from fastapi import FastAPI as app).

pub const fn is_nonlocal(&self) -> bool

Return true if this Binding represents a nonlocal. A Binding is a nonlocal if it’s declared by a nonlocal statement, or shadows a Binding declared by a nonlocal statement.

pub const fn is_global(&self) -> bool

Return true if this Binding represents a global. A Binding is a global if it’s declared by a global statement, or shadows a Binding declared by a global statement.

pub const fn is_deleted(&self) -> bool

Return true if this Binding was deleted.

pub const fn is_invalid_all_format(&self) -> bool

Return true if this Binding represents an assignment to __all__ with an invalid value (e.g., __all__ = "Foo").

pub const fn is_invalid_all_object(&self) -> bool

Return true if this Binding represents an assignment to __all__ that includes an invalid member (e.g., __all__ = ["Foo", 1]).

pub const fn is_unpacked_assignment(&self) -> bool

Return true if this Binding represents an unpacked assignment (e.g., x in (x, y) = 1, 2).

pub const fn is_unbound(&self) -> bool

Return true if this Binding represents an unbound variable (e.g., x in x = 1; del x).

pub const fn is_private_declaration(&self) -> bool

Return true if this Binding represents an private declaration (e.g., _x in _x = "private variable")

pub const fn in_exception_handler(&self) -> bool

Return true if this Binding took place inside an exception handler, e.g. y in:

try:
     x = 42
except RuntimeError:
     y = 42

pub const fn in_assert_statement(&self) -> bool

Return true if this Binding took place inside an assert statement, e.g. y in:

assert (y := x**2), y

pub const fn is_annotated_type_alias(&self) -> bool

Return true if this Binding represents a PEP 613 type alias e.g. OptString in:

from typing import TypeAlias

OptString: TypeAlias = str | None

pub const fn is_deferred_type_alias(&self) -> bool

Return true if this Binding represents a PEP 695 type alias e.g. OptString in:

type OptString = str | None

pub const fn is_type_alias(&self) -> bool

Return true if this Binding represents either kind of type alias

pub fn redefines(&self, existing: &Binding<'_>) -> bool

Return true if this binding “redefines” the given binding, as per Pyflake’s definition of redefinition.

pub fn name<'b>(&self, source: &'b str) -> &'b str

Returns the name of the binding (e.g., x in x = 1).

pub fn statement<'b>(&self, semantic: &SemanticModel<'b>) -> Option<&'b Stmt>

Returns the statement in which the binding was defined.

pub fn expression<'b>(&self, semantic: &SemanticModel<'b>) -> Option<&'b Expr>

Returns the expression in which the binding was defined (e.g. for the binding x in y = (x := 1), return the node representing x := 1).

This is only really applicable for assignment expressions.

pub fn parent_range(&self, semantic: &SemanticModel<'_>) -> Option<TextRange>

Returns the range of the binding’s parent.

pub fn as_any_import(&self) -> Option<AnyImport<'_, 'a>>

Trait Implementations

impl<'a> Clone for Binding<'a>

fn clone(&self) -> Binding<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for Binding<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> FromIterator<Binding<'a>> for Bindings<'a>

fn from_iter<T: IntoIterator<Item = Binding<'a>>>(iter: T) -> Self

Creates a value from an iterator.

impl Ranged for Binding<'_>

fn range(&self) -> TextRange

The range of this item in the source text.

fn start(&self) -> TextSize

The start offset of this item in the source text.

fn end(&self) -> TextSize

The end offset of this item in the source text.