pip._internal.metadata._json Namespace Reference

Functions
str	json_name (str field)
Dict[str, Any]	msg_to_json (Message msg)

Variables
list	METADATA_FIELDS

Function Documentation

json_name()

str json_name

(

str

field

)

Definition at line 37 of file _json.py.

def json_name(field: str) -> str:
    return field.lower().replace("-", "_")
 
 

References i.

Referenced by pip._internal.metadata._json.msg_to_json().

Here is the caller graph for this function:

msg_to_json()

Dict[str, Any] msg_to_json

(

Message

msg

)

Convert a Message object into a JSON-compatible dictionary.

Definition at line 41 of file _json.py.

def msg_to_json(msg: Message) -> Dict[str, Any]:
    """Convert a Message object into a JSON-compatible dictionary."""
 
    def sanitise_header(h: Union[Header, str]) -> str:
        if isinstance(h, Header):
            chunks = []
            for bytes, encoding in decode_header(h):
                if encoding == "unknown-8bit":
                    try:
                        # See if UTF-8 works
                        bytes.decode("utf-8")
                        encoding = "utf-8"
                    except UnicodeDecodeError:
                        # If not, latin1 at least won't fail
                        encoding = "latin1"
                chunks.append((bytes, encoding))
            return str(make_header(chunks))
        return str(h)
 
    result = {}
    for field, multi in METADATA_FIELDS:
        if field not in msg:
            continue
        key = json_name(field)
        if multi:
            value: Union[str, List[str]] = [
                sanitise_header(v) for v in msg.get_all(field)
            ]
        else:
            value = sanitise_header(msg.get(field))
            if key == "keywords":
                # Accept both comma-separated and space-separated
                # forms, for better compatibility with old data.
                if "," in value:
                    value = [v.strip() for v in value.split(",")]
                else:
                    value = value.split()
        result[key] = value
 
    payload = msg.get_payload()
    if payload:
        result["description"] = payload
 
    return result

References i, and pip._internal.metadata._json.json_name().

Here is the call graph for this function:

Variable Documentation

METADATA_FIELDS

list METADATA_FIELDS

Initial value:

=  [
    # Name, Multiple-Use
    ("Metadata-Version", False),
    ("Name", False),
    ("Version", False),
    ("Dynamic", True),
    ("Platform", True),
    ("Supported-Platform", True),
    ("Summary", False),
    ("Description", False),
    ("Description-Content-Type", False),
    ("Keywords", False),
    ("Home-page", False),
    ("Download-URL", False),
    ("Author", False),
    ("Author-email", False),
    ("Maintainer", False),
    ("Maintainer-email", False),
    ("License", False),
    ("Classifier", True),
    ("Requires-Dist", True),
    ("Requires-Python", False),
    ("Requires-External", True),
    ("Project-URL", True),
    ("Provides-Extra", True),
    ("Provides-Dist", True),
    ("Obsoletes-Dist", True),
]

Definition at line 7 of file _json.py.