# `Filesystem`: A Centralized Registry of Common Filesystem Paths

```{py:currentmodule} my.apis.Filesystem
```

```{eval-rst}
.. autodata:: my.apis.Filesystem.fs
```

```{eval-rst}
.. autoclass:: my.apis.Filesystem.Filesystem
```

## `I` Primary Methods

```{eval-rst}
.. automethod:: my.apis.Filesystem.Filesystem.compile_rgx
```

## `II` Public Methods

```{eval-rst}
.. autoproperty:: my.apis.Filesystem.Filesystem.rgxs
```

```{eval-rst}
.. automethod:: my.apis.Filesystem.Filesystem.is_possible
```

```{eval-rst}
.. automethod:: my.apis.Filesystem.Filesystem.is_actual
```

```{eval-rst}
.. automethod:: my.apis.Filesystem.Filesystem.path
```

```{eval-rst}
.. automethod:: my.apis.Filesystem.Filesystem.is_relative_to
```

```{eval-rst}
.. automethod:: my.apis.Filesystem.Filesystem.relativize
```

```{eval-rst}
.. automethod:: my.apis.Filesystem.Filesystem.seek_project
```

```{eval-rst}
.. automethod:: my.apis.Filesystem.Filesystem.shortpath
```