dependence.update

update

update(
    paths: collections.abc.Iterable[str],
    ignore: collections.abc.Iterable[str] = (),
    all_extra_name: str = "",
    include_pointers: tuple[str, ...] = (),
    exclude_pointers: tuple[str, ...] = (),
) -> None

Update requirement versions in the specified files.

Parameters:

• path –

  One or more local paths to a setup.cfg, setup.cfg, and/or requirements.txt files

• ignore (collections.abc.Iterable[str], default: () ) –

  One or more project names to ignore (leave as-is)

• all_extra_name (str, default: '' ) –

  If provided, an extra which consolidates the requirements for all other extras will be added/updated to setup.cfg or setup.cfg (this argument is ignored for requirements.txt files)

• include_pointers (tuple[str, ...], default: () ) –

  A tuple of JSON pointers indicating elements to include (defaults to all elements).

• exclude_pointers (tuple[str, ...], default: () ) –

  A tuple of JSON pointers indicating elements to exclude (defaults to no exclusions).

Source code in src/dependence/update.py

def update(
    paths: Iterable[str],
    ignore: Iterable[str] = (),
    all_extra_name: str = "",
    include_pointers: tuple[str, ...] = (),
    exclude_pointers: tuple[str, ...] = (),
) -> None:
    """
    Update requirement versions in the specified files.

    Parameters:
        path: One or more local paths to a setup.cfg,
            setup.cfg, and/or requirements.txt files
        ignore: One or more project names to ignore (leave as-is)
        all_extra_name: If provided, an extra which consolidates
            the requirements for all other extras will be added/updated to
            setup.cfg or setup.cfg (this argument is ignored for
            requirements.txt files)
        include_pointers: A tuple of JSON pointers indicating elements to
            include (defaults to all elements).
        exclude_pointers: A tuple of JSON pointers indicating elements to
            exclude (defaults to no exclusions).
    """
    if isinstance(paths, str):
        paths = (paths,)

    def update_(path: str) -> None:
        _update(
            path,
            ignore=ignore,
            all_extra_name=all_extra_name,
            include_pointers=include_pointers,
            exclude_pointers=exclude_pointers,
        )

    deque(map(update_, paths), maxlen=0)