Skip to content

Refactor Config to extract DefaultConfig and RepositoryConfig subclasses #1501

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jdavid merged 1 commit into from
Oct 20, 2026
Merged

Refactor Config to extract DefaultConfig and RepositoryConfig subclasses #1501

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 15 additions & 6 deletions docs/config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,31 @@
Configuration files
**********************************************************************

.. autoclass:: pygit2.Repository
:members: config
:noindex:
.. autoclass:: pygit2.repository.BaseRepository
:members: config, config_snapshot


The Config type
The Config types
================

.. autoclass:: pygit2.Config
:members:
:undoc-members:
:special-members: __contains__, __delitem__, __getitem__, __iter__, __setitem__
:special-members: __contains__, __delitem__, __getitem__, __init__, __iter__, __setitem__

.. autoclass:: pygit2.DefaultConfig
:members: add_file, snapshot
:undoc-members:
:special-members: __init__

.. autoclass:: pygit2.RepositoryConfig
:members: add_file, snapshot
:undoc-members:
:special-members: __init__


The ConfigEntry type
====================

.. autoclass:: pygit2.config.ConfigEntry
:members: name, value, level
:members: level, name, raw_level, raw_name, raw_value, value, __eq__, __hash__
8 changes: 7 additions & 1 deletion pygit2/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,11 @@
git_fetch_options,
git_proxy_options,
)
from .config import Config
from .config import (
Config,
DefaultConfig,
RepositoryConfig,
)
from .credentials import *
from .errors import (
AlreadyExistsError,
Expand Down Expand Up @@ -606,6 +610,7 @@ def filter_unregister(name: str) -> None:
'Branch',
'CertificateError',
'Commit',
'DefaultConfig',
'Diff',
'DiffDelta',
'DiffFile',
Expand Down Expand Up @@ -941,6 +946,7 @@ def filter_unregister(name: str) -> None:
'Remote',
'repository',
'Repository',
'RepositoryConfig',
'branches',
'references',
'settings',
Expand Down
Loading
Loading