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

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

Module - Griffe

The class representing a Python module.

The aliases pointing to this object.

All members (declared and inherited).

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

The attribute members.

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

The full dotted path of this object.

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

See also: path.

The class members.

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

deprecated: bool | str | None = None

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

The ending line number of the object.

See also: lineno.

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

Exports can contain string (object names) or resolvable names, like other lists of exports coming from submodules:

from .submodule import __all__ as submodule_all

__all__ = ["hello", *submodule_all]

Exports get expanded by the loader before it expands wildcards and resolves aliases.

See also: GriffeLoader.expand_exports.

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

The file path of this module.

Raises:

• BuiltinModuleError –

  When the instance filepath is None.

The function members.

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

Whether this object or any of its members has a docstring (empty or not).

Inherited members are not considered. Imported members are not considered, unless they are also public.

See also: docstring, has_docstring.

The other objects imported by this object.

Keys are the names within the object (from ... import ... as AS_NAME), while the values are the actual names of the objects (from ... import REAL_NAME as ...).

imports_future_annotations: bool

Whether this module import future annotations.

Always false for objects.

Only aliases can be marked as inherited.

Members that are inherited from base classes.

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

See also: members.

Always false for objects.

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

is_collection: bool = False

Always false for objects.

Whether this object is deprecated.

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

Whether this object is generic.

Whether this object/alias was imported from another module.

Whether this module is an __init__.py module.

See also: is_module.

is_namespace_package: bool

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

See also: is_namespace_subpackage.

is_namespace_subpackage: bool

Whether this module is a namespace subpackage.

See also: is_namespace_package.

Whether this module is a package (top module).

See also: is_subpackage.

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

Whether this object is considered public.

In modules, developers can mark objects as public thanks to the __all__ variable. In classes however, there is no convention or standard to do so.

Therefore, to decide whether an object is public, we follow this algorithm:

• If the object's public attribute is set (boolean), return its value.
• If the object is listed in its parent's (a module) __all__ attribute, it is public.
• If the parent (module) defines __all__ and the object is not listed in, it is private.
• If the object has a private name, it is private.
• If the object was imported from another module, it is private.
• Otherwise, the object is public.

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

Whether this module is a subpackage.

See also: is_package.

is_wildcard_exposed: bool

Whether this object/alias is exposed to wildcard imports.

To be exposed to wildcard imports, an object/alias must:

• be available at runtime
• have a module as parent
• be listed in __all__ if __all__ is defined
• or not be private (having a name starting with an underscore)

Special case for Griffe trees: a submodule is only exposed if its parent imports it.

Returns:

• bool –

  True or False.

The object kind.

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

See also: has_labels.

The starting line number of the object.

See also: endlineno.

The lines collection attached to this object or its parents.

See also: lines, source.

Raises:

• ValueError –

  When no modules collection can be found in the object or its parents.

The parent module of this object.

See also: package.

Examples:

>>> import griffe
>>> markdown = griffe.load("markdown")
>>> markdown["core.Markdown.references"].module
Module(PosixPath('~/project/.venv/lib/python3.11/site-packages/markdown/core.py'))
>>> # The `module` of a module is itself.
>>> markdown["core"].module
Module(PosixPath('~/project/.venv/lib/python3.11/site-packages/markdown/core.py'))

Raises:

• ValueError –

  When the object is not a module and does not have a parent.

The module members.

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

The modules collection attached to this object or its parents.

Raises:

• ValueError –

  When no modules collection can be found in the object or its parents.

The object name.

The overloaded signatures declared in this module.

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

See also: module.

Examples:

>>> import griffe
>>> markdown = griffe.load("markdown")
>>> markdown["core.Markdown.references"].package
Module(PosixPath('~/project/.venv/lib/python3.11/site-packages/markdown/__init__.py'))

The parent of the object (none if top module).

The dotted path of this object.

On regular objects (not aliases), the path is the canonical path.

See also: canonical_path.

Examples:

>>> import griffe
>>> markdown = griffe.load("markdown")
>>> markdown["core.Markdown.references"].path
'markdown.core.Markdown.references'

public: bool | None = None

Whether this object is public.

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

If this object's file path is not relative to the current working directory, return its absolute path.

See also: filepath, relative_package_filepath.

Raises:

• ValueError –

  When the relative path could not be computed.

relative_package_filepath: Path

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

See also: filepath, relative_filepath.

Raises:

• ValueError –

  When the relative path could not be computed.

Whether this object is available at runtime.

Typically, type-guarded objects (under an if TYPE_CHECKING condition) are not available at runtime.

The type alias members.

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

The object type parameters.

An object is always true-ish.

Delete a member with its name or path.

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

Members will be looked up in both declared members and inherited ones, triggering computation of the latter.

Parameters:

• key ¤ (str | Sequence[str]) –

  The name or path of the member.

Examples:

>>> del griffe_object["foo"]
>>> del griffe_object["path.to.bar"]
>>> del griffe_object[("path", "to", "qux")]

Get a member with its name or path.

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

Members will be looked up in both declared members and inherited ones, triggering computation of the latter.

Parameters:

• key ¤ (str | Sequence[str]) –

  The name or path of the member.

Examples:

>>> foo = griffe_object["foo"]
>>> bar = griffe_object["path.to.bar"]
>>> qux = griffe_object[("path", "to", "qux")]

The number of members in this object, recursively.

Set a member with its name or path.

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

Parameters:

• key ¤ (str | Sequence[str]) –

  The name or path of the member.

• value ¤ (Object | Alias) –

  The member.

Examples:

>>> griffe_object["foo"] = foo
>>> griffe_object["path.to.bar"] = bar
>>> griffe_object[("path", "to", "qux")] = qux

Return this module's data as a dictionary.

See also: as_json.

Parameters:

• **kwargs ¤ (Any, default: {} ) –

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

Return this object's data as a JSON string.

Parameters:

• full ¤ (bool, default: False ) –

  Whether to return full info, or just base info.

• **kwargs ¤ (Any, default: {} ) –

  Additional serialization options passed to encoder.

Returns:

• str –

  A JSON string.

Delete a member with its name or path.

This method is part of the producer API: you can use it safely while building Griffe trees (for example in Griffe extensions).

Members will be looked up in declared members only, not inherited ones.

Parameters:

• key ¤ (str | Sequence[str]) –

  The name or path of the member.

Examples:

>>> griffe_object.del_member("foo")
>>> griffe_object.del_member("path.to.bar")
>>> griffe_object.del_member(("path", "to", "qux"))

Filter and return members based on predicates.

See also: members.

Parameters:

• *predicates ¤ (Callable[[Object | Alias], bool], default: () ) –

  A list of predicates, i.e. callables accepting a member as argument and returning a boolean.

Returns:

• dict[str, Object | Alias] –

  A dictionary of members.

Create an instance of this class from a JSON string.

Parameters:

• json_string ¤ (str) –

  JSON to decode into Object.

• **kwargs ¤ (Any, default: {} ) –

  Additional options passed to decoder.

Returns:

• _ObjType –

  An Object instance.

Raises:

• TypeError –

  When the json_string does not represent and object of the class from which this classmethod has been called.

Get a member with its name or path.

This method is part of the producer API: you can use it safely while building Griffe trees (for example in Griffe extensions).

Members will be looked up in declared members only, not inherited ones.

Parameters:

• key ¤ (str | Sequence[str]) –

  The name or path of the member.

Examples:

>>> foo = griffe_object["foo"]
>>> bar = griffe_object["path.to.bar"]
>>> bar = griffe_object[("path", "to", "bar")]

Tell if this object has all the given labels.

See also: labels.

Parameters:

• *labels ¤ (str, default: () ) –

  Labels that must be present.

Returns:

• bool –

  True or False.

Resolve a name within this object's and parents' scope.

Parameters:

• name ¤ (str) –

  The name to resolve.

Raises:

• NameResolutionError –

  When the name could not be resolved.

Returns:

• str –

  The resolved name.

Set a member with its name or path.

This method is part of the producer API: you can use it safely while building Griffe trees (for example in Griffe extensions).

Parameters:

• key ¤ (str | Sequence[str]) –

  The name or path of the member.

• value ¤ (Object | Alias) –

  The member.

Examples:

>>> griffe_object.set_member("foo", foo)
>>> griffe_object.set_member("path.to.bar", bar)
>>> griffe_object.set_member(("path", "to", "qux"), qux)

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4