sitecustomize._utils

sitecustomize._utils.

Module Contents

Classes

NamedObject

Base class for protocol classes.

SimpleWarning

Functions

fifo_filter(ordered_list)

Remove duplicate entries from an ordered list,
class sitecustomize._utils.NamedObject

Bases: Protocol

Base class for protocol classes.

Protocol classes are defined as:

class Proto(Protocol):
    def meth(self) -> int:
        ...

Such classes are primarily used with static type checkers that recognize structural subtyping (static duck-typing), for example:

class C:
    def meth(self) -> int:
        return 0

def func(x: Proto) -> int:
    return x.meth()

func(C())  # Passes static type check

See PEP 544 for details. Protocol classes decorated with @typing.runtime_checkable act as simple-minded runtime protocols that check only the presence of given attributes, ignoring their type signatures. Protocol classes can be generic, they are defined as:

class GenProto(Protocol[T]):
    def meth(self) -> T:
        ...
name: str
sitecustomize._utils.fifo_filter(ordered_list)

Remove duplicate entries from an ordered list, preserving initial ordering but removing previously seen entries.

Example

>>> fifo_filter([1, 2, 3, 1])
  [2, 3, 1]

This allows you to override the ordering of a registered entrypoint in your own pyproject.toml.

Parameters:

ordered_list (List[NamedObject]) –

Return type:

List[NamedObject]

class sitecustomize._utils.SimpleWarning
__enter__()
__exit__(*args)
static simple_warning_format(msg, category, filename, lineno, file=None, line=None)

Simple warning-formatting.