Skip to content

ExtendedFilter

faststream.cli.supervisors.watchfiles.ExtendedFilter #

ExtendedFilter(
    *,
    ignore_paths: Optional[
        Sequence[Union[str, Path]]
    ] = None,
    extra_extensions: Sequence[str] = ()
)

Bases: PythonFilter

A class that extends the watchfiles.PythonFilter class.

METHOD DESCRIPTION
__init__

Initializes the ExtendedFilter object Args: ignore_paths : Optional sequence of paths to ignore extra_extensions : Sequence of extra extensions to include

Returns: None

Note

The above docstring is autogenerated by docstring-gen library (https://docstring-gen.airt.ai)

Initialize the class.

PARAMETER DESCRIPTION
ignore_paths

Optional sequence of paths to ignore.

TYPE: Optional[Sequence[Union[str, Path]]] DEFAULT: None

extra_extensions

Sequence of extra extensions.

TYPE: Sequence[str] DEFAULT: ()

RETURNS DESCRIPTION
None

None

Note

The above docstring is autogenerated by docstring-gen library (https://docstring-gen.airt.ai)

Source code in faststream/cli/supervisors/watchfiles.py 
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
def __init__(
    self,
    *,
    ignore_paths: Optional[Sequence[Union[str, Path]]] = None,
    extra_extensions: Sequence[str] = (),
) -> None:
    """Initialize the class.

    Args:
        ignore_paths: Optional sequence of paths to ignore.
        extra_extensions: Sequence of extra extensions.

    Returns:
        None
    !!! note

        The above docstring is autogenerated by docstring-gen library (https://docstring-gen.airt.ai)
    """
    super().__init__(ignore_paths=ignore_paths, extra_extensions=extra_extensions)
    self.extensions = self.extensions + (".env", ".yaml")
    self.ignore_dirs = self.ignore_dirs + (
        "venv",
        "env",
        ".github",
        ".mypy_cache",
        ".pytest_cache",
        ".ruff_cache",
    )

extensions instance-attribute #

extensions = self.extensions + ('.env', '.yaml')

ignore_dirs instance-attribute #

ignore_dirs: Tuple[str, ...] = self.ignore_dirs + (
    "venv",
    "env",
    ".github",
    ".mypy_cache",
    ".pytest_cache",
    ".ruff_cache",
)
Last update: 2023-11-13