osfs ⚓︎

Os specific filesystem utils/operations

Classes:

OsFsAbc –

Abstract base class for OS-specific symlink operations
LIN –

Linux (and Mac) shell commands/methods container
WIN –

Windows shell commands/methods container

OsFsAbc ⚓︎

Bases: ABC

Abstract base class for OS-specific symlink operations

Implemented by LIN (linux/mac) and WIN (windows); all members are static methods, so the subclasses are used as namespaces rather than instantiated.

Methods:

link_dir –

Make a directory symlink
link_dirs –

Make multiple directory symlinks
link_file –

Make a file symlink
link_files –

Make multiple file symlinks
unlink_dir –

Unlink a directory symlink
unlink_dirs –

Unlink multiple directory symlinks
unlink_file –

Unlink a file symlink
unlink_files –

Unlink multiple file symlinks

link_dir `abstractmethod` `staticmethod` ⚓︎

link_dir(
    linkpath: str,
    targetpath: str,
    *,
    exist_ok: bool = False,
) -> None

Make a directory symlink

Parameters:

linkpath ⚓︎
(str) –

Path to the link to be made
targetpath ⚓︎
(str) –

Path to the target of the link to be made
exist_ok ⚓︎
(bool, default: False ) –

Allow the link to already exist

link_dirs `abstractmethod` `staticmethod` ⚓︎

link_dirs(
    link_target_tuples: list[tuple[str, str]],
    *,
    exist_ok: bool = False,
) -> None

Make multiple directory symlinks

Parameters:

link_target_tuples ⚓︎
(list[tuple[str, str]]) –

Iterable of (link, target) tuples
exist_ok ⚓︎
(bool, default: False ) –

Allow the links to already exist

link_file `abstractmethod` `staticmethod` ⚓︎

link_file(
    linkpath: str,
    targetpath: str,
    *,
    exist_ok: bool = False,
) -> None

Make a file symlink

Parameters:

linkpath ⚓︎
(str) –

Path to the link to be made
targetpath ⚓︎
(str) –

Path to the target of the link to be made
exist_ok ⚓︎
(bool, default: False ) –

Allow the link to already exist

link_files `abstractmethod` `staticmethod` ⚓︎

link_files(
    link_target_tuples: list[tuple[str, str]],
    *,
    exist_ok: bool = False,
) -> None

Make multiple file symlinks

Parameters:

link_target_tuples ⚓︎
(list[tuple[str, str]]) –

Iterable of (link, target) tuples
exist_ok ⚓︎
(bool, default: False ) –

Allow the links to already exist

unlink_dir `abstractmethod` `staticmethod` ⚓︎

unlink_dir(link: str) -> None

Unlink a directory symlink

Parameters:

link ⚓︎
(str) –

Path to the symlink

unlink_dirs `abstractmethod` `staticmethod` ⚓︎

unlink_dirs(links: Iterable[str]) -> None

Unlink multiple directory symlinks

Parameters:

links ⚓︎
(Iterable[str]) –

Iterable of paths to symlinks

unlink_file `abstractmethod` `staticmethod` ⚓︎

unlink_file(link: str) -> None

Unlink a file symlink

Parameters:

link ⚓︎
(str) –

Path to the symlink

unlink_files `abstractmethod` `staticmethod` ⚓︎

unlink_files(links: Iterable[str]) -> None

Unlink multiple file symlinks

Parameters:

links ⚓︎
(Iterable[str]) –

Iterable of paths to symlinks

LIN ⚓︎

Bases: OsFsAbc

Linux (and Mac) shell commands/methods container

Methods:

link_dir –

Make a directory symlink
link_dirs –

Make multiple directory symlinks
link_file –

Make a file symlink
link_files –

Make multiple file symlinks
unlink_dir –

Unlink a directory symlink given a path to the symlink
unlink_dirs –

Unlink directory symlinks given the paths the links
unlink_file –

Unlink a file symlink given a path to the symlink
unlink_files –

Unlink directory symlinks given the paths the links

link_dir `staticmethod` ⚓︎

link_dir(
    linkpath: str,
    targetpath: str,
    *,
    exist_ok: bool = False,
) -> None

Make a directory symlink

Parameters:

linkpath ⚓︎
(str) –

Path to the link to be made
targetpath ⚓︎
(str) –

Path to the target of the link to be made
exist_ok ⚓︎
(bool, default: False ) –

Allow link to exist

link_dirs `staticmethod` ⚓︎

link_dirs(
    link_target_tuples: list[tuple[str, str]],
    *,
    exist_ok: bool = False,
) -> None

Make multiple directory symlinks

Parameters:

link_target_tuples ⚓︎
(list[tuple[str, str]]) –

Iterable of tuples of the form: (link, target) or a dictionary mapping with key => value pairs of the form link => target.
exist_ok ⚓︎
(bool, default: False ) –

Allow link to exist

link_file `staticmethod` ⚓︎

link_file(
    linkpath: str,
    targetpath: str,
    *,
    exist_ok: bool = False,
) -> None

Make a file symlink

Parameters:

linkpath ⚓︎
(str) –

Path to the link to be made
targetpath ⚓︎
(str) –

Path to the target of the link to be made
exist_ok ⚓︎
(bool, default: False ) –

Allow links to already exist

link_files `staticmethod` ⚓︎

link_files(
    link_target_tuples: list[tuple[str, str]],
    *,
    exist_ok: bool = False,
) -> None

Make multiple file symlinks

Parameters:

exist_ok ⚓︎
(bool, default: False ) –

Allow links to already exist
link_target_tuples ⚓︎
(list[tuple[str, str]]) –

Iterable of tuples of the form: (link, target) or a dictionary mapping with key => value pairs of the form link => target.

unlink_dir `staticmethod` ⚓︎

unlink_dir(link: str) -> None

Unlink a directory symlink given a path to the symlink

Parameters:

link ⚓︎
(str) –

path to the symlink

unlink_dirs `staticmethod` ⚓︎

unlink_dirs(links: Iterable[str]) -> None

Unlink directory symlinks given the paths the links

Parameters:

links ⚓︎
(Iterable[str]) –

Iterable of paths to links

unlink_file `staticmethod` ⚓︎

unlink_file(link: str) -> None

Unlink a file symlink given a path to the symlink

Parameters:

link ⚓︎
(str) –

path to the symlink

unlink_files `staticmethod` ⚓︎

unlink_files(links: Iterable[str]) -> None

Unlink directory symlinks given the paths the links

Parameters:

links ⚓︎
(Iterable[str]) –

Iterable of paths to links

WIN ⚓︎

Bases: OsFsAbc

Windows shell commands/methods container

Methods:

link_dir –

Make a directory symlink
link_dirs –

Make multiple directory symlinks
link_file –

Make a file symlink
link_files –

Make multiple file symlinks
unlink_dir –

Unlink a directory symlink given a path to the symlink
unlink_dirs –

Unlink directory symlinks given the paths the links
unlink_file –

Unlink a file symlink given a path to the symlink
unlink_files –

Unlink directory symlinks given the paths the links

link_dir `staticmethod` ⚓︎

link_dir(
    linkpath: str,
    targetpath: str,
    *,
    exist_ok: bool = False,
) -> None

Make a directory symlink

Parameters:

linkpath ⚓︎
(str) –

Path to the link to be made
targetpath ⚓︎
(str) –

Path to the target of the link to be made
exist_ok ⚓︎
(bool, default: False ) –

If True, do not raise an exception if the link exists

link_dirs `staticmethod` ⚓︎

link_dirs(
    link_target_tuples: list[tuple[str, str]],
    *,
    exist_ok: bool = False,
) -> None

Make multiple directory symlinks

Parameters:

link_target_tuples ⚓︎
(list[tuple[str, str]]) –

Iterable of tuples of the form: (link, target) or a dictionary mapping with key => value pairs of the form link => target.
exist_ok ⚓︎
(bool, default: False ) –

If True, do not raise an exception if the link(s) exist

link_file `staticmethod` ⚓︎

link_file(
    linkpath: str,
    targetpath: str,
    *,
    exist_ok: bool = False,
) -> None

Make a file symlink

Parameters:

linkpath ⚓︎
(str) –

Path to the link to be made
targetpath ⚓︎
(str) –

Path to the target of the link to be made
exist_ok ⚓︎
(bool, default: False ) –

If True, don't raise an exception if the link exists

link_files `staticmethod` ⚓︎

link_files(
    link_target_tuples: list[tuple[str, str]],
    *,
    exist_ok: bool = False,
) -> None

Make multiple file symlinks

Parameters:

link_target_tuples ⚓︎
(list[tuple[str, str]]) –

Iterable of tuples of the form: (link, target) or a dictionary mapping with key => value pairs of the form link => target.
exist_ok ⚓︎
(bool, default: False ) –

If True, don't raise an exception if the link exists

unlink_dir `staticmethod` ⚓︎

unlink_dir(link: str) -> None

Unlink a directory symlink given a path to the symlink

Parameters:

link ⚓︎
(str) –

path to the symlink

unlink_dirs `staticmethod` ⚓︎

unlink_dirs(links: Iterable[str]) -> None

Unlink directory symlinks given the paths the links

Parameters:

links ⚓︎
(Iterable[str]) –

Iterable of paths to links

unlink_file `staticmethod` ⚓︎

unlink_file(link: str) -> None

Unlink a file symlink given a path to the symlink

Parameters:

link ⚓︎
(str) –

path to the symlink

unlink_files `staticmethod` ⚓︎

unlink_files(links: Iterable[str]) -> None

Unlink directory symlinks given the paths the links

Parameters:

links ⚓︎
(Iterable[str]) –

Iterable of paths to links

osfs ⚓︎

OsFsAbc ⚓︎

link_dir abstractmethod staticmethod ⚓︎

linkpath ⚓︎

targetpath ⚓︎

exist_ok ⚓︎

link_dirs abstractmethod staticmethod ⚓︎

link_target_tuples ⚓︎

exist_ok ⚓︎

link_file abstractmethod staticmethod ⚓︎

linkpath ⚓︎

targetpath ⚓︎

exist_ok ⚓︎

link_files abstractmethod staticmethod ⚓︎

link_target_tuples ⚓︎

exist_ok ⚓︎

unlink_dir abstractmethod staticmethod ⚓︎

link ⚓︎

unlink_dirs abstractmethod staticmethod ⚓︎

links ⚓︎

unlink_file abstractmethod staticmethod ⚓︎

link ⚓︎

unlink_files abstractmethod staticmethod ⚓︎

links ⚓︎

LIN ⚓︎

link_dir staticmethod ⚓︎

linkpath ⚓︎

targetpath ⚓︎

exist_ok ⚓︎

link_dirs staticmethod ⚓︎

link_target_tuples ⚓︎

exist_ok ⚓︎

link_file staticmethod ⚓︎

linkpath ⚓︎

targetpath ⚓︎

exist_ok ⚓︎

link_files staticmethod ⚓︎

exist_ok ⚓︎

link_target_tuples ⚓︎

unlink_dir staticmethod ⚓︎

link ⚓︎

unlink_dirs staticmethod ⚓︎

links ⚓︎

unlink_file staticmethod ⚓︎

link ⚓︎

unlink_files staticmethod ⚓︎

links ⚓︎

WIN ⚓︎

link_dir staticmethod ⚓︎

linkpath ⚓︎

targetpath ⚓︎

exist_ok ⚓︎

link_dirs staticmethod ⚓︎

link_target_tuples ⚓︎

exist_ok ⚓︎

link_file staticmethod ⚓︎

linkpath ⚓︎

targetpath ⚓︎

exist_ok ⚓︎

link_files staticmethod ⚓︎

link_target_tuples ⚓︎

exist_ok ⚓︎

unlink_dir staticmethod ⚓︎

link ⚓︎

unlink_dirs staticmethod ⚓︎

links ⚓︎

unlink_file staticmethod ⚓︎

link ⚓︎

unlink_files staticmethod ⚓︎

links ⚓︎

link_dir `abstractmethod` `staticmethod` ⚓︎

`linkpath` ⚓︎

`targetpath` ⚓︎

`exist_ok` ⚓︎

link_dirs `abstractmethod` `staticmethod` ⚓︎

`link_target_tuples` ⚓︎

`exist_ok` ⚓︎

link_file `abstractmethod` `staticmethod` ⚓︎

`linkpath` ⚓︎

`targetpath` ⚓︎

`exist_ok` ⚓︎

link_files `abstractmethod` `staticmethod` ⚓︎

`link_target_tuples` ⚓︎

`exist_ok` ⚓︎

unlink_dir `abstractmethod` `staticmethod` ⚓︎

`link` ⚓︎

unlink_dirs `abstractmethod` `staticmethod` ⚓︎

`links` ⚓︎

unlink_file `abstractmethod` `staticmethod` ⚓︎

`link` ⚓︎

unlink_files `abstractmethod` `staticmethod` ⚓︎

`links` ⚓︎

link_dir `staticmethod` ⚓︎

`linkpath` ⚓︎

`targetpath` ⚓︎

`exist_ok` ⚓︎

link_dirs `staticmethod` ⚓︎

`link_target_tuples` ⚓︎

`exist_ok` ⚓︎

link_file `staticmethod` ⚓︎

`linkpath` ⚓︎

`targetpath` ⚓︎

`exist_ok` ⚓︎

link_files `staticmethod` ⚓︎

`exist_ok` ⚓︎

`link_target_tuples` ⚓︎

unlink_dir `staticmethod` ⚓︎

`link` ⚓︎

unlink_dirs `staticmethod` ⚓︎

`links` ⚓︎

unlink_file `staticmethod` ⚓︎

`link` ⚓︎

unlink_files `staticmethod` ⚓︎

`links` ⚓︎

link_dir `staticmethod` ⚓︎

`linkpath` ⚓︎

`targetpath` ⚓︎

`exist_ok` ⚓︎

link_dirs `staticmethod` ⚓︎

`link_target_tuples` ⚓︎

`exist_ok` ⚓︎

link_file `staticmethod` ⚓︎

`linkpath` ⚓︎

`targetpath` ⚓︎

`exist_ok` ⚓︎

link_files `staticmethod` ⚓︎

`link_target_tuples` ⚓︎

`exist_ok` ⚓︎

unlink_dir `staticmethod` ⚓︎

`link` ⚓︎

unlink_dirs `staticmethod` ⚓︎

`links` ⚓︎

unlink_file `staticmethod` ⚓︎

`link` ⚓︎

unlink_files `staticmethod` ⚓︎

`links` ⚓︎