RawMetadata class final

RawMetadata

python docstring

A dictionary of raw core metadata.

Each field in core metadata maps to a key of this dictionary (when data is provided). The key is lower-case and underscores are used instead of dashes compared to the equivalent core metadata field. Any core metadata field that can be specified multiple times or can hold multiple values in a single field have a key with a plural name.

Core metadata fields that can be specified multiple times are stored as a list or dict depending on which is appropriate for the field. Any fields which hold multiple values in a single field are stored as a list.

python source

class RawMetadata(TypedDict, total=False):
    """A dictionary of raw core metadata.

    Each field in core metadata maps to a key of this dictionary (when data is
    provided). The key is lower-case and underscores are used instead of dashes
    compared to the equivalent core metadata field. Any core metadata field that
    can be specified multiple times or can hold multiple values in a single
    field have a key with a plural name.

    Core metadata fields that can be specified multiple times are stored as a
    list or dict depending on which is appropriate for the field. Any fields
    which hold multiple values in a single field are stored as a list.

    """

    # Metadata 1.0 - PEP 241
    metadata_version: str
    name: str
    version: str
    platforms: List[str]
    summary: str
    description: str
    keywords: List[str]
    home_page: str
    author: str
    author_email: str
    license: str

    # Metadata 1.1 - PEP 314
    supported_platforms: List[str]
    download_url: str
    classifiers: List[str]
    requires: List[str]
    provides: List[str]
    obsoletes: List[str]

    # Metadata 1.2 - PEP 345
    maintainer: str
    maintainer_email: str
    requires_dist: List[str]
    provides_dist: List[str]
    obsoletes_dist: List[str]
    requires_python: str
    requires_external: List[str]
    project_urls: Dict[str, str]

    # Metadata 2.0
    # PEP 426 attempted to completely revamp the metadata format
    # but got stuck without ever being able to build consensus on
    # it and ultimately ended up withdrawn.
    #
    # However, a number of tools had started emiting METADATA with
    # `2.0` Metadata-Version, so for historical reasons, this version
    # was skipped.

    # Metadata 2.1 - PEP 566
    description_content_type: str
    provides_extra: List[str]

    # Metadata 2.2 - PEP 643
    dynamic: List[str]

    # Metadata 2.3 - PEP 685
    # No new fields were added in PEP 685, just some edge case were
    # tightened up to provide better interoptability.

Inheritance

Object
PythonObjectInterface<PythonFfiDelegate<Object?>, Object?>
PythonObject
PythonClass
RawMetadata

Constructors

RawMetadata(): factory
RawMetadata.from(PythonClassInterface<PythonFfiDelegate<Object?>, Object?> pythonClass)

Properties

$get ↔ Object?: get (getter)
getter/setter pair
clear ↔ Object?: clear (getter)
getter/setter pair
copy ↔ Object?: copy (getter)
getter/setter pair
finalizer → Finalizer<(PythonFfiDelegate<Object?>, Object?)>: The finalizer for the python object. Gets invoked when the object is no longer accessible to the program.
finalinherited
hashCode → int: The hash code for this object.
no setterinherited
initializer → Initializer<PythonFfiDelegate<Object?>, Object?>: The initializer for the python object. Gets invoked at the start of the constructor.
finalinherited
items ↔ Object?: items (getter)
getter/setter pair
keys ↔ Object?: keys (getter)
getter/setter pair
platform → PythonFfiDelegate<Object?>: Gets the platform that this object is associated with.
no setterinherited
pop ↔ Object?: pop (getter)
getter/setter pair
popitem ↔ Object?: popitem (getter)
getter/setter pair
reference → Object?: Gets the reference to the python object.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
setdefault ↔ Object?: setdefault (getter)
getter/setter pair
update ↔ Object?: update (getter)
getter/setter pair
values ↔ Object?: values (getter)
getter/setter pair

Methods

debugDump() → void: Dumps the python object to the console.
inherited
getAttribute<T extends Object?>(String attributeName) → T: Gets the attribute with the given name.
inherited
getAttributeOrNull<T extends Object?>(String attributeName) → T?: Gets the attribute with the given name or null if it does not exist.
inherited
getAttributeRaw<T extends PythonObjectInterface<PythonFfiDelegate<Object?>, Object?>>(String attributeName) → T: Gets the attribute with the given name.
inherited
getFunction(String name) → PythonFunctionInterface<PythonFfiDelegate<Object?>, Object?>: Gets the function with the given name.
inherited
getMethod(String functionName) → PythonFunctionInterface<PythonFfiDelegate<Object?>, Object?>: Gets a method from the class.
inherited
hasAttribute(String attributeName) → bool: Checks if the python object has the given attribute.
inherited
noSuchMethod(Invocation invocation) → Object?: Invoked when a nonexistent method or property is accessed.
inherited
setAttribute<T extends Object?>(String attributeName, T value) → void: Sets the attribute with the given name.
inherited
setAttributeRaw<T extends PythonObjectInterface<PythonFfiDelegate<Object?>, Object?>>(String attributeName, T value) → void: Sets the attribute with the given name.
inherited
toDartObject() → Object?: Converts the python object to a Dart object.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited