RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://mkdocstrings.github.io/griffe/reference/api/models/alias/ below:

Alias - Griffe

This class represents an alias, or indirection, to an object declared in another module.

Aliases represent objects that are in the scope of a module or class, but were imported from another module.

alias_endlineno (int | None) –

The ending line number of the alias.

alias_lineno (int | None) –

The starting line number of the alias.

aliases (dict[str, Alias]) –

The aliases pointing to this object.

all_members (dict[str, Object | Alias]) –

All members (declared and inherited).

annotation (str | Expr | None) –

The attribute type annotation.

attributes (dict[str, Attribute]) –

The attribute members.

bases (list[Expr | str]) –

The class bases.

canonical_path (str) –

The full dotted path of this object.

classes (dict[str, Class]) –

The class members.

decorators (list[Decorator]) –

The class/function decorators.

deleter (Function | None) –

The deleter linked to this function (property).

deprecated (str | bool | None) –

Whether this alias is deprecated (boolean or deprecation message).

docstring (Docstring | None) –

The target docstring.

endlineno (int | None) –

The ending line number of the target object.

exports (list[str | ExprName] | None) –

The names of the objects exported by this (module) object through the __all__ variable.

extra (dict) –

Namespaced dictionaries storing extra metadata for this object, used by extensions.

filepath (Path | list[Path]) –

The file path (or directory list for namespace packages) where this object was defined.

final_target (Object) –

The final, resolved target, if possible.

functions (dict[str, Function]) –

The function members.

has_docstring (bool) –

Whether this alias' target has a non-empty docstring.

has_docstrings (bool) –

Whether this alias' target or any of its members has a non-empty docstring.

imports (dict[str, str]) –

The other objects imported by this alias' target.

imports_future_annotations (bool) –

Whether this module import future annotations.

inherited (bool) –

Whether this alias represents an inherited member.

inherited_members (dict[str, Alias]) –

Members that are inherited from base classes.

is_alias (bool) –

Always true for aliases.

is_attribute (bool) –

Whether this object is an attribute.

is_class (bool) –

Whether this object is a class.

is_class_private (bool) –

Whether this object/alias is class-private (starts with __ and is a class member).

is_collection (bool) –

Always false for aliases.

is_deprecated (bool) –

Whether this object is deprecated.

is_exported (bool) –

Whether this object/alias is exported (listed in __all__).

is_function (bool) –

Whether this object is a function.

is_generic (bool) –

Whether this object is generic.

is_imported (bool) –

Whether this object/alias was imported from another module.

is_init_module (bool) –

Whether this module is an __init__.py module.

is_module (bool) –

Whether this object is a module.

is_namespace_package (bool) –

Whether this module is a namespace package (top folder, no __init__.py).

is_namespace_subpackage (bool) –

Whether this module is a namespace subpackage.

is_package (bool) –

Whether this module is a package (top module).

is_private (bool) –

Whether this object/alias is private (starts with _) but not special.

is_public (bool) –

Whether this object is considered public.

is_special (bool) –

Whether this object/alias is special ("dunder" attribute/method, starts and end with __).

is_subpackage (bool) –

Whether this module is a subpackage.

is_type_alias (bool) –

Whether this object is a type alias.

is_wildcard_exposed (bool) –

Whether this object/alias is exposed to wildcard imports.

kind (Kind) –

The target's kind, or Kind.ALIAS if the target cannot be resolved.

labels (set[str]) –

The target labels (property, dataclass, etc.).

lineno (int | None) –

The starting line number of the target object.

lines (list[str]) –

The lines containing the source of this object.

lines_collection (LinesCollection) –

The lines collection attached to this object or its parents.

members (dict[str, Object | Alias]) –

The target's members (modules, classes, functions, attributes, type aliases).

module (Module) –

The parent module of this object.

modules (dict[str, Module]) –

The module members.

modules_collection (ModulesCollection) –

The modules collection attached to the alias parents.

name (str) –

The alias name.

overloads (dict[str, list[Function]] | list[Function] | None) –

The overloaded signatures declared in this class/module or for this function.

package (Module) –

The absolute top module (the package) of this object.

parameters (Parameters) –

The parameters of the current function or __init__ method for classes.

parent (Module | Class | Alias | None) –

The parent of this alias.

path (str) –

The dotted path / import path of this object.

public (bool | None) –

Whether this alias is public.

relative_filepath (Path) –

The file path where this object was defined, relative to the current working directory.

relative_package_filepath (Path) –

The file path where this object was defined, relative to the top module path.

resolved (bool) –

Whether this alias' target is resolved.

resolved_bases (list[Object]) –

Resolved class bases.

returns (str | Expr | None) –

The function return type annotation.

runtime (bool) –

Whether this alias is available at runtime.

setter (Function | None) –

The setter linked to this function (property).

source (str) –

The source code of this object.

target (Object | Alias) –

The resolved target (actual object), if possible.

target_path (str) –

The path of this alias' target.

type_aliases (dict[str, TypeAlias]) –

The type alias members.

type_parameters (TypeParameters) –

The target type parameters.

value (str | Expr | None) –

The attribute or type alias value.

wildcard (str | None) –

The module on which the wildcard import is performed (if any).

alias_endlineno instance-attribute ¤

The ending line number of the alias.

alias_lineno instance-attribute ¤

The starting line number of the alias.

aliases property ¤

The aliases pointing to this object.

all_members property ¤

All members (declared and inherited).

This method is part of the consumer API: do not use when producing Griffe trees!

annotation property writable ¤

The attribute type annotation.

attributes property ¤

The attribute members.

This method is part of the consumer API: do not use when producing Griffe trees!

canonical_path property ¤

The full dotted path of this object.

The canonical path is the path where the object was defined (not imported).