Categorize __all__ symbols

Author: Andrej730

pygit2/__init__.py

@@ -244,53 +244,70 @@ def clone_repository(
 settings = Settings()
 
 __all__ = (
-    'AlreadyExistsError',
+    # Standard Library
+    'functools',
+    'os',
+    'typing',
+    # Standard Library symbols
+    'TYPE_CHECKING',
     'annotations',
-    'blame',
-    'Blame',
-    'BlameHunk',
-    'blob',
+    # Low level API
+    'GIT_OID_HEX_ZERO',
+    'GIT_OID_HEXSZ',
+    'GIT_OID_MINPREFIXLEN',
+    'GIT_OID_RAWSZ',
+    'LIBGIT2_VER_MAJOR',
+    'LIBGIT2_VER_MINOR',
+    'LIBGIT2_VER_REVISION',
+    'LIBGIT2_VERSION',
+    'Object',
+    'Reference',
+    'AlreadyExistsError',
     'Blob',
-    'BlobIO',
     'Branch',
-    'branches',
-    'C',
-    'callbacks',
-    'check_error',
-    'CheckoutCallbacks',
-    'clone_repository',
     'Commit',
-    'config',
-    'Config',
-    'credentials',
-    'CredentialType',
     'Diff',
     'DiffDelta',
     'DiffFile',
     'DiffHunk',
     'DiffLine',
     'DiffStats',
+    'GitError',
+    'InvalidSpecError',
+    'Mailmap',
+    'Note',
+    'Odb',
+    'OdbBackend',
+    'OdbBackendLoose',
+    'OdbBackendPack',
+    'Oid',
+    'Patch',
+    'RefLogEntry',
+    'Refdb',
+    'RefdbBackend',
+    'RefdbFsBackend',
+    'RevSpec',
+    'Signature',
+    'Stash',
+    'Tag',
+    'Tree',
+    'TreeBuilder',
+    'Walker',
+    'Worktree',
     'discover_repository',
-    'enums',
-    'errors',
-    'features',
-    'ffi',
+    'hash',
+    'hashfile',
+    'init_file_backend',
+    'option',
+    'reference_is_valid_name',
+    'tree_entry_cmp',
+    # Low Level API (not present in .pyi)
+    'FilterSource',
     'filter_register',
     'filter_unregister',
-    'filter',
-    'Filter',
-    'FilterSource',
-    'functools',
-    'get_credentials',
     'GIT_APPLY_LOCATION_BOTH',
     'GIT_APPLY_LOCATION_INDEX',
     'GIT_APPLY_LOCATION_WORKDIR',
-    'GIT_ATTR_CHECK_FILE_THEN_INDEX',
-    'GIT_ATTR_CHECK_INCLUDE_COMMIT',
-    'GIT_ATTR_CHECK_INCLUDE_HEAD',
-    'GIT_ATTR_CHECK_INDEX_ONLY',
-    'GIT_ATTR_CHECK_INDEX_THEN_FILE',
-    'GIT_ATTR_CHECK_NO_SYSTEM',
     'GIT_BLAME_FIRST_PARENT',
     'GIT_BLAME_IGNORE_WHITESPACE',
     'GIT_BLAME_NORMAL',
@@ -319,13 +336,6 @@ def clone_repository(
     'GIT_CHECKOUT_FORCE',
     'GIT_CHECKOUT_NO_REFRESH',
     'GIT_CHECKOUT_NONE',
-    'GIT_CHECKOUT_NOTIFY_ALL',
-    'GIT_CHECKOUT_NOTIFY_CONFLICT',
-    'GIT_CHECKOUT_NOTIFY_DIRTY',
-    'GIT_CHECKOUT_NOTIFY_IGNORED',
-    'GIT_CHECKOUT_NOTIFY_NONE',
-    'GIT_CHECKOUT_NOTIFY_UNTRACKED',
-    'GIT_CHECKOUT_NOTIFY_UPDATED',
     'GIT_CHECKOUT_RECREATE_MISSING',
     'GIT_CHECKOUT_REMOVE_IGNORED',
     'GIT_CHECKOUT_REMOVE_UNTRACKED',
@@ -335,7 +345,6 @@ def clone_repository(
     'GIT_CHECKOUT_UPDATE_ONLY',
     'GIT_CHECKOUT_USE_OURS',
     'GIT_CHECKOUT_USE_THEIRS',
-    'git_clone_options',
     'GIT_CONFIG_HIGHEST_LEVEL',
     'GIT_CONFIG_LEVEL_APP',
     'GIT_CONFIG_LEVEL_GLOBAL',
@@ -344,13 +353,6 @@ def clone_repository(
     'GIT_CONFIG_LEVEL_SYSTEM',
     'GIT_CONFIG_LEVEL_WORKTREE',
     'GIT_CONFIG_LEVEL_XDG',
-    'GIT_CREDENTIAL_DEFAULT',
-    'GIT_CREDENTIAL_SSH_CUSTOM',
-    'GIT_CREDENTIAL_SSH_INTERACTIVE',
-    'GIT_CREDENTIAL_SSH_KEY',
-    'GIT_CREDENTIAL_SSH_MEMORY',
-    'GIT_CREDENTIAL_USERNAME',
-    'GIT_CREDENTIAL_USERPASS_PLAINTEXT',
     'GIT_DELTA_ADDED',
     'GIT_DELTA_CONFLICTED',
     'GIT_DELTA_COPIED',
@@ -422,14 +424,6 @@ def clone_repository(
     'GIT_DIFF_STATS_NUMBER',
     'GIT_DIFF_STATS_SHORT',
     'GIT_DIFF_UPDATE_INDEX',
-    'GIT_FEATURE_HTTPS',
-    'GIT_FEATURE_NSEC',
-    'GIT_FEATURE_SSH',
-    'GIT_FEATURE_THREADS',
-    'GIT_FETCH_NO_PRUNE',
-    'git_fetch_options',
-    'GIT_FETCH_PRUNE_UNSPECIFIED',
-    'GIT_FETCH_PRUNE',
     'GIT_FILEMODE_BLOB_EXECUTABLE',
     'GIT_FILEMODE_BLOB',
     'GIT_FILEMODE_COMMIT',
@@ -462,10 +456,6 @@ def clone_repository(
     'GIT_OBJECT_REF_DELTA',
     'GIT_OBJECT_TAG',
     'GIT_OBJECT_TREE',
-    'GIT_OID_HEX_ZERO',
-    'GIT_OID_HEXSZ',
-    'GIT_OID_MINPREFIXLEN',
-    'GIT_OID_RAWSZ',
     'GIT_OPT_DISABLE_PACK_KEEP_FILE_CHECKS',
     'GIT_OPT_ENABLE_CACHING',
     'GIT_OPT_ENABLE_FSYNC_GITDIR',
@@ -498,37 +488,9 @@ def clone_repository(
     'GIT_OPT_SET_TEMPLATE_PATH',
     'GIT_OPT_SET_USER_AGENT',
     'GIT_OPT_SET_WINDOWS_SHAREMODE',
-    'git_proxy_options',
     'GIT_REFERENCES_ALL',
     'GIT_REFERENCES_BRANCHES',
     'GIT_REFERENCES_TAGS',
-    'GIT_REPOSITORY_INIT_BARE',
-    'GIT_REPOSITORY_INIT_EXTERNAL_TEMPLATE',
-    'GIT_REPOSITORY_INIT_MKDIR',
-    'GIT_REPOSITORY_INIT_MKPATH',
-    'GIT_REPOSITORY_INIT_NO_DOTGIT_DIR',
-    'GIT_REPOSITORY_INIT_NO_REINIT',
-    'GIT_REPOSITORY_INIT_RELATIVE_GITLINK',
-    'GIT_REPOSITORY_INIT_SHARED_ALL',
-    'GIT_REPOSITORY_INIT_SHARED_GROUP',
-    'GIT_REPOSITORY_INIT_SHARED_UMASK',
-    'GIT_REPOSITORY_OPEN_BARE',
-    'GIT_REPOSITORY_OPEN_CROSS_FS',
-    'GIT_REPOSITORY_OPEN_FROM_ENV',
-    'GIT_REPOSITORY_OPEN_NO_DOTGIT',
-    'GIT_REPOSITORY_OPEN_NO_SEARCH',
-    'GIT_REPOSITORY_STATE_APPLY_MAILBOX_OR_REBASE',
-    'GIT_REPOSITORY_STATE_APPLY_MAILBOX',
-    'GIT_REPOSITORY_STATE_BISECT',
-    'GIT_REPOSITORY_STATE_CHERRYPICK_SEQUENCE',
-    'GIT_REPOSITORY_STATE_CHERRYPICK',
-    'GIT_REPOSITORY_STATE_MERGE',
-    'GIT_REPOSITORY_STATE_NONE',
-    'GIT_REPOSITORY_STATE_REBASE_INTERACTIVE',
-    'GIT_REPOSITORY_STATE_REBASE_MERGE',
-    'GIT_REPOSITORY_STATE_REBASE',
-    'GIT_REPOSITORY_STATE_REVERT_SEQUENCE',
-    'GIT_REPOSITORY_STATE_REVERT',
     'GIT_RESET_HARD',
     'GIT_RESET_MIXED',
     'GIT_RESET_SOFT',
@@ -540,14 +502,6 @@ def clone_repository(
     'GIT_SORT_TIME',
     'GIT_SORT_TOPOLOGICAL',
     'GIT_STASH_APPLY_DEFAULT',
-    'GIT_STASH_APPLY_PROGRESS_ANALYZE_INDEX',
-    'GIT_STASH_APPLY_PROGRESS_ANALYZE_MODIFIED',
-    'GIT_STASH_APPLY_PROGRESS_ANALYZE_UNTRACKED',
-    'GIT_STASH_APPLY_PROGRESS_CHECKOUT_MODIFIED',
-    'GIT_STASH_APPLY_PROGRESS_CHECKOUT_UNTRACKED',
-    'GIT_STASH_APPLY_PROGRESS_DONE',
-    'GIT_STASH_APPLY_PROGRESS_LOADING_STASH',
-    'GIT_STASH_APPLY_PROGRESS_NONE',
     'GIT_STASH_APPLY_REINSTATE_INDEX',
     'GIT_STASH_DEFAULT',
     'GIT_STASH_INCLUDE_IGNORED',
@@ -587,72 +541,124 @@ def clone_repository(
     'GIT_SUBMODULE_STATUS_WD_UNINITIALIZED',
     'GIT_SUBMODULE_STATUS_WD_UNTRACKED',
     'GIT_SUBMODULE_STATUS_WD_WD_MODIFIED',
-    'GitError',
-    'hash',
-    'hashfile',
-    'index',
-    'Index',
-    'IndexEntry',
-    'init_file_backend',
-    'init_repository',
-    'InvalidSpecError',
+    # High level API.
+    'enums',
+    'blame',
+    'Blame',
+    'BlameHunk',
+    'blob',
+    'BlobIO',
+    'callbacks',
+    'Payload',
+    'RemoteCallbacks',
+    'CheckoutCallbacks',
+    'StashApplyCallbacks',
+    'git_clone_options',
+    'git_fetch_options',
+    'git_proxy_options',
+    'get_credentials',
+    'config',
+    'Config',
+    'credentials',
+    'CredentialType',
+    'Username',
+    'UserPass',
     'Keypair',
     'KeypairFromAgent',
     'KeypairFromMemory',
+    'errors',
+    'check_error',
+    'Passthrough',
+    'ffi',
+    'C',
+    'filter',
+    'Filter',
+    'index',
+    'Index',
+    'IndexEntry',
     'legacyenums',
-    'LIBGIT2_VER_MAJOR',
-    'LIBGIT2_VER_MINOR',
-    'LIBGIT2_VER_REVISION',
-    'LIBGIT2_VER',
-    'LIBGIT2_VERSION',
-    'Mailmap',
-    'Note',
-    'Object',
-    'Odb',
-    'OdbBackend',
-    'OdbBackendLoose',
-    'OdbBackendPack',
-    'Oid',
-    'option',
-    'os',
+    'GIT_FEATURE_THREADS',
+    'GIT_FEATURE_HTTPS',
+    'GIT_FEATURE_SSH',
+    'GIT_FEATURE_NSEC',
+    'GIT_REPOSITORY_INIT_BARE',
+    'GIT_REPOSITORY_INIT_NO_REINIT',
+    'GIT_REPOSITORY_INIT_NO_DOTGIT_DIR',
+    'GIT_REPOSITORY_INIT_MKDIR',
+    'GIT_REPOSITORY_INIT_MKPATH',
+    'GIT_REPOSITORY_INIT_EXTERNAL_TEMPLATE',
+    'GIT_REPOSITORY_INIT_RELATIVE_GITLINK',
+    'GIT_REPOSITORY_INIT_SHARED_UMASK',
+    'GIT_REPOSITORY_INIT_SHARED_GROUP',
+    'GIT_REPOSITORY_INIT_SHARED_ALL',
+    'GIT_REPOSITORY_OPEN_NO_SEARCH',
+    'GIT_REPOSITORY_OPEN_CROSS_FS',
+    'GIT_REPOSITORY_OPEN_BARE',
+    'GIT_REPOSITORY_OPEN_NO_DOTGIT',
+    'GIT_REPOSITORY_OPEN_FROM_ENV',
+    'GIT_REPOSITORY_STATE_NONE',
+    'GIT_REPOSITORY_STATE_MERGE',
+    'GIT_REPOSITORY_STATE_REVERT',
+    'GIT_REPOSITORY_STATE_REVERT_SEQUENCE',
+    'GIT_REPOSITORY_STATE_CHERRYPICK',
+    'GIT_REPOSITORY_STATE_CHERRYPICK_SEQUENCE',
+    'GIT_REPOSITORY_STATE_BISECT',
+    'GIT_REPOSITORY_STATE_REBASE',
+    'GIT_REPOSITORY_STATE_REBASE_INTERACTIVE',
+    'GIT_REPOSITORY_STATE_REBASE_MERGE',
+    'GIT_REPOSITORY_STATE_APPLY_MAILBOX',
+    'GIT_REPOSITORY_STATE_APPLY_MAILBOX_OR_REBASE',
+    'GIT_ATTR_CHECK_FILE_THEN_INDEX',
+    'GIT_ATTR_CHECK_INDEX_THEN_FILE',
+    'GIT_ATTR_CHECK_INDEX_ONLY',
+    'GIT_ATTR_CHECK_NO_SYSTEM',
+    'GIT_ATTR_CHECK_INCLUDE_HEAD',
+    'GIT_ATTR_CHECK_INCLUDE_COMMIT',
+    'GIT_FETCH_PRUNE_UNSPECIFIED',
+    'GIT_FETCH_PRUNE',
+    'GIT_FETCH_NO_PRUNE',
+    'GIT_CHECKOUT_NOTIFY_NONE',
+    'GIT_CHECKOUT_NOTIFY_CONFLICT',
+    'GIT_CHECKOUT_NOTIFY_DIRTY',
+    'GIT_CHECKOUT_NOTIFY_UPDATED',
+    'GIT_CHECKOUT_NOTIFY_UNTRACKED',
+    'GIT_CHECKOUT_NOTIFY_IGNORED',
+    'GIT_CHECKOUT_NOTIFY_ALL',
+    'GIT_STASH_APPLY_PROGRESS_NONE',
+    'GIT_STASH_APPLY_PROGRESS_LOADING_STASH',
+    'GIT_STASH_APPLY_PROGRESS_ANALYZE_INDEX',
+    'GIT_STASH_APPLY_PROGRESS_ANALYZE_MODIFIED',
+    'GIT_STASH_APPLY_PROGRESS_ANALYZE_UNTRACKED',
+    'GIT_STASH_APPLY_PROGRESS_CHECKOUT_UNTRACKED',
+    'GIT_STASH_APPLY_PROGRESS_CHECKOUT_MODIFIED',
+    'GIT_STASH_APPLY_PROGRESS_DONE',
+    'GIT_CREDENTIAL_USERPASS_PLAINTEXT',
+    'GIT_CREDENTIAL_SSH_KEY',
+    'GIT_CREDENTIAL_SSH_CUSTOM',
+    'GIT_CREDENTIAL_DEFAULT',
+    'GIT_CREDENTIAL_SSH_INTERACTIVE',
+    'GIT_CREDENTIAL_USERNAME',
+    'GIT_CREDENTIAL_SSH_MEMORY',
     'packbuilder',
     'PackBuilder',
-    'Passthrough',
-    'Patch',
-    'Payload',
-    'Refdb',
-    'RefdbBackend',
-    'RefdbFsBackend',
-    'reference_is_valid_name',
-    'Reference',
-    'references',
-    'RefLogEntry',
     'refspec',
-    'Remote',
-    'RemoteCallbacks',
     'remotes',
+    'Remote',
     'repository',
     'Repository',
-    'RevSpec',
+    'branches',
+    'references',
     'settings',
     'Settings',
-    'Signature',
-    'Stash',
-    'StashApplyCallbacks',
-    'Submodule',
     'submodules',
-    'Tag',
+    'Submodule',
+    'utils',
     'to_bytes',
     'to_str',
-    'tree_entry_cmp',
+    # __init__ module defined symbols
+    'features',
+    'LIBGIT2_VER',
+    'init_repository',
+    'clone_repository',
     'tree_entry_key',
-    'Tree',
-    'TreeBuilder',
-    'TYPE_CHECKING',
-    'typing',
-    'Username',
-    'UserPass',
-    'utils',
-    'Walker',
-    'Worktree',
 )