# {py:mod}`simvx.core.git_status`

```{py:module} simvx.core.git_status
```

```{autodoc2-docstring} simvx.core.git_status
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`Status <simvx.core.git_status.Status>`
  - ```{autodoc2-docstring} simvx.core.git_status.Status
    :summary:
    ```
* - {py:obj}`GitStatusProvider <simvx.core.git_status.GitStatusProvider>`
  - ```{autodoc2-docstring} simvx.core.git_status.GitStatusProvider
    :summary:
    ```
````

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`parse_porcelain_v2 <simvx.core.git_status.parse_porcelain_v2>`
  - ```{autodoc2-docstring} simvx.core.git_status.parse_porcelain_v2
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`log <simvx.core.git_status.log>`
  - ```{autodoc2-docstring} simvx.core.git_status.log
    :summary:
    ```
* - {py:obj}`__all__ <simvx.core.git_status.__all__>`
  - ```{autodoc2-docstring} simvx.core.git_status.__all__
    :summary:
    ```
````

### API

````{py:data} log
:canonical: simvx.core.git_status.log
:value: >
   'getLogger(...)'

```{autodoc2-docstring} simvx.core.git_status.log
```

````

````{py:data} __all__
:canonical: simvx.core.git_status.__all__
:value: >
   ['Status', 'GitStatusProvider', 'parse_porcelain_v2']

```{autodoc2-docstring} simvx.core.git_status.__all__
```

````

`````{py:class} Status()
:canonical: simvx.core.git_status.Status

Bases: {py:obj}`enum.StrEnum`

```{autodoc2-docstring} simvx.core.git_status.Status
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.git_status.Status.__init__
```

````{py:attribute} CLEAN
:canonical: simvx.core.git_status.Status.CLEAN
:value: >
   'clean'

```{autodoc2-docstring} simvx.core.git_status.Status.CLEAN
```

````

````{py:attribute} MODIFIED_UNSAVED
:canonical: simvx.core.git_status.Status.MODIFIED_UNSAVED
:value: >
   'modified_unsaved'

```{autodoc2-docstring} simvx.core.git_status.Status.MODIFIED_UNSAVED
```

````

````{py:attribute} SAVED_UNCOMMITTED
:canonical: simvx.core.git_status.Status.SAVED_UNCOMMITTED
:value: >
   'saved_uncommitted'

```{autodoc2-docstring} simvx.core.git_status.Status.SAVED_UNCOMMITTED
```

````

````{py:attribute} COMMITTED_UNPUSHED
:canonical: simvx.core.git_status.Status.COMMITTED_UNPUSHED
:value: >
   'committed_unpushed'

```{autodoc2-docstring} simvx.core.git_status.Status.COMMITTED_UNPUSHED
```

````

````{py:attribute} CONFLICTED
:canonical: simvx.core.git_status.Status.CONFLICTED
:value: >
   'conflicted'

```{autodoc2-docstring} simvx.core.git_status.Status.CONFLICTED
```

````

````{py:attribute} UNTRACKED
:canonical: simvx.core.git_status.Status.UNTRACKED
:value: >
   'untracked'

```{autodoc2-docstring} simvx.core.git_status.Status.UNTRACKED
```

````

````{py:method} __new__(*values)
:canonical: simvx.core.git_status.Status.__new__

````

````{py:method} __add__()
:canonical: simvx.core.git_status.Status.__add__

````

````{py:method} __contains__()
:canonical: simvx.core.git_status.Status.__contains__

````

````{py:method} __delattr__()
:canonical: simvx.core.git_status.Status.__delattr__

````

````{py:method} __dir__()
:canonical: simvx.core.git_status.Status.__dir__

````

````{py:method} __eq__()
:canonical: simvx.core.git_status.Status.__eq__

````

````{py:method} __format__()
:canonical: simvx.core.git_status.Status.__format__

````

````{py:method} __ge__()
:canonical: simvx.core.git_status.Status.__ge__

````

````{py:method} __getattribute__()
:canonical: simvx.core.git_status.Status.__getattribute__

````

````{py:method} __getitem__()
:canonical: simvx.core.git_status.Status.__getitem__

````

````{py:method} __getnewargs__()
:canonical: simvx.core.git_status.Status.__getnewargs__

````

````{py:method} __getstate__()
:canonical: simvx.core.git_status.Status.__getstate__

````

````{py:method} __gt__()
:canonical: simvx.core.git_status.Status.__gt__

````

````{py:method} __hash__()
:canonical: simvx.core.git_status.Status.__hash__

````

````{py:method} __iter__()
:canonical: simvx.core.git_status.Status.__iter__

````

````{py:method} __le__()
:canonical: simvx.core.git_status.Status.__le__

````

````{py:method} __len__()
:canonical: simvx.core.git_status.Status.__len__

````

````{py:method} __lt__()
:canonical: simvx.core.git_status.Status.__lt__

````

````{py:method} __mod__()
:canonical: simvx.core.git_status.Status.__mod__

````

````{py:method} __mul__()
:canonical: simvx.core.git_status.Status.__mul__

````

````{py:method} __ne__()
:canonical: simvx.core.git_status.Status.__ne__

````

````{py:method} __reduce__()
:canonical: simvx.core.git_status.Status.__reduce__

````

````{py:method} __reduce_ex__()
:canonical: simvx.core.git_status.Status.__reduce_ex__

````

````{py:method} __repr__()
:canonical: simvx.core.git_status.Status.__repr__

````

````{py:method} __rmod__()
:canonical: simvx.core.git_status.Status.__rmod__

````

````{py:method} __rmul__()
:canonical: simvx.core.git_status.Status.__rmul__

````

````{py:method} __setattr__()
:canonical: simvx.core.git_status.Status.__setattr__

````

````{py:method} __sizeof__()
:canonical: simvx.core.git_status.Status.__sizeof__

````

````{py:method} __str__()
:canonical: simvx.core.git_status.Status.__str__

````

````{py:method} __subclasshook__()
:canonical: simvx.core.git_status.Status.__subclasshook__

````

````{py:method} capitalize()
:canonical: simvx.core.git_status.Status.capitalize

````

````{py:method} casefold()
:canonical: simvx.core.git_status.Status.casefold

````

````{py:method} center()
:canonical: simvx.core.git_status.Status.center

````

````{py:method} count()
:canonical: simvx.core.git_status.Status.count

````

````{py:method} encode()
:canonical: simvx.core.git_status.Status.encode

````

````{py:method} endswith()
:canonical: simvx.core.git_status.Status.endswith

````

````{py:method} expandtabs()
:canonical: simvx.core.git_status.Status.expandtabs

````

````{py:method} find()
:canonical: simvx.core.git_status.Status.find

````

````{py:method} format()
:canonical: simvx.core.git_status.Status.format

````

````{py:method} format_map()
:canonical: simvx.core.git_status.Status.format_map

````

````{py:method} index()
:canonical: simvx.core.git_status.Status.index

````

````{py:method} isalnum()
:canonical: simvx.core.git_status.Status.isalnum

````

````{py:method} isalpha()
:canonical: simvx.core.git_status.Status.isalpha

````

````{py:method} isascii()
:canonical: simvx.core.git_status.Status.isascii

````

````{py:method} isdecimal()
:canonical: simvx.core.git_status.Status.isdecimal

````

````{py:method} isdigit()
:canonical: simvx.core.git_status.Status.isdigit

````

````{py:method} isidentifier()
:canonical: simvx.core.git_status.Status.isidentifier

````

````{py:method} islower()
:canonical: simvx.core.git_status.Status.islower

````

````{py:method} isnumeric()
:canonical: simvx.core.git_status.Status.isnumeric

````

````{py:method} isprintable()
:canonical: simvx.core.git_status.Status.isprintable

````

````{py:method} isspace()
:canonical: simvx.core.git_status.Status.isspace

````

````{py:method} istitle()
:canonical: simvx.core.git_status.Status.istitle

````

````{py:method} isupper()
:canonical: simvx.core.git_status.Status.isupper

````

````{py:method} join()
:canonical: simvx.core.git_status.Status.join

````

````{py:method} ljust()
:canonical: simvx.core.git_status.Status.ljust

````

````{py:method} lower()
:canonical: simvx.core.git_status.Status.lower

````

````{py:method} lstrip()
:canonical: simvx.core.git_status.Status.lstrip

````

````{py:method} partition()
:canonical: simvx.core.git_status.Status.partition

````

````{py:method} removeprefix()
:canonical: simvx.core.git_status.Status.removeprefix

````

````{py:method} removesuffix()
:canonical: simvx.core.git_status.Status.removesuffix

````

````{py:method} replace()
:canonical: simvx.core.git_status.Status.replace

````

````{py:method} rfind()
:canonical: simvx.core.git_status.Status.rfind

````

````{py:method} rindex()
:canonical: simvx.core.git_status.Status.rindex

````

````{py:method} rjust()
:canonical: simvx.core.git_status.Status.rjust

````

````{py:method} rpartition()
:canonical: simvx.core.git_status.Status.rpartition

````

````{py:method} rsplit()
:canonical: simvx.core.git_status.Status.rsplit

````

````{py:method} rstrip()
:canonical: simvx.core.git_status.Status.rstrip

````

````{py:method} split()
:canonical: simvx.core.git_status.Status.split

````

````{py:method} splitlines()
:canonical: simvx.core.git_status.Status.splitlines

````

````{py:method} startswith()
:canonical: simvx.core.git_status.Status.startswith

````

````{py:method} strip()
:canonical: simvx.core.git_status.Status.strip

````

````{py:method} swapcase()
:canonical: simvx.core.git_status.Status.swapcase

````

````{py:method} title()
:canonical: simvx.core.git_status.Status.title

````

````{py:method} translate()
:canonical: simvx.core.git_status.Status.translate

````

````{py:method} upper()
:canonical: simvx.core.git_status.Status.upper

````

````{py:method} zfill()
:canonical: simvx.core.git_status.Status.zfill

````

````{py:method} __deepcopy__(memo)
:canonical: simvx.core.git_status.Status.__deepcopy__

````

````{py:method} __copy__()
:canonical: simvx.core.git_status.Status.__copy__

````

````{py:method} name()
:canonical: simvx.core.git_status.Status.name

````

````{py:method} value()
:canonical: simvx.core.git_status.Status.value

````

`````

````{py:function} parse_porcelain_v2(porcelain_output: str, untracked_output: str = '', repo_root: pathlib.Path | None = None) -> tuple[dict[pathlib.Path, simvx.core.git_status.Status], bool]
:canonical: simvx.core.git_status.parse_porcelain_v2

```{autodoc2-docstring} simvx.core.git_status.parse_porcelain_v2
```
````

`````{py:class} GitStatusProvider(repo_root: pathlib.Path, dirty_paths_callback: collections.abc.Callable[[], set[pathlib.Path]] | None = None, poll_interval: float = 2.0)
:canonical: simvx.core.git_status.GitStatusProvider

```{autodoc2-docstring} simvx.core.git_status.GitStatusProvider
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.git_status.GitStatusProvider.__init__
```

````{py:method} status_for(path: pathlib.Path | str) -> simvx.core.git_status.Status
:canonical: simvx.core.git_status.GitStatusProvider.status_for

```{autodoc2-docstring} simvx.core.git_status.GitStatusProvider.status_for
```

````

````{py:property} is_active
:canonical: simvx.core.git_status.GitStatusProvider.is_active
:type: bool

```{autodoc2-docstring} simvx.core.git_status.GitStatusProvider.is_active
```

````

````{py:method} refresh() -> None
:canonical: simvx.core.git_status.GitStatusProvider.refresh

```{autodoc2-docstring} simvx.core.git_status.GitStatusProvider.refresh
```

````

````{py:method} stop(timeout: float | None = 1.0) -> None
:canonical: simvx.core.git_status.GitStatusProvider.stop

```{autodoc2-docstring} simvx.core.git_status.GitStatusProvider.stop
```

````

`````