Deprecate public access to typing imports in git · gitpython-developers/GitPython@c8ad3a3 · GitHub

gitpython-developers / GitPython Public

• Notifications You must be signed in to change notification settings
• Fork 989
• Star 5.2k

• Code
• Issues 8
• Pull requests 2
• Discussions
• Actions
• Security and quality 34
• Insights

Additional navigation options

Commit c8ad3a3

Browse filesBrowse the repository at this point in the historyBrowse files

EliahKagan

committed

Deprecate public access to typing imports in git

This adds comments to entries in git.__all__ for each of the entries that come from the standard library typing module, noting them as deprecated. These imports were included in __all__ inadvertently due to the way __all__ was dynamically constructed, and placed in __all__ explicitly when __all__ became static in #1659. They are there for backward compatibility, in case some code relies on them being there. But a module is unlikely to rely intentionally on the git module providing them, since they are not conceptually related to GitPython. `from git import *` should not typically be used, since wildcard imports are not generally recommended, as discussed in PEP-8. But if someone does choose to use it, they would probably benefit less from DeprecationWarning being issued for each of those names than they would usually benefit from DeprecationWarning. This could lead to developers deciding not to enable DeprecationWarning when it may otherwise be useful. For this reason, no attempt is currently made to issue DeprecationWarning when those names are accessed as attributes of the git module.

1 parent e49327d commit c8ad3a3
Copy full SHA for c8ad3a3

1 file changed

+6-6Lines changed: 6 additions & 6 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• git
  • __init__.py

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎git/__init__.py‎

Copy file name to clipboardExpand all lines: git/__init__.py

+6-6Lines changed: 6 additions & 6 deletions

Original file line number	Diff line number	Diff line change
@@ -38,13 +38,13 @@
38	38	"IndexObject",
39	39	"InvalidDBRoot",
40	40	"InvalidGitRepositoryError",
41		- "List",
	41	+ "List", # Deprecated - import this from `typing` instead.
42	42	"LockFile",
43	43	"NULL_TREE",
44	44	"NoSuchPathError",
45	45	"ODBError",
46	46	"Object",
47		- "Optional",
	47	+ "Optional", # Deprecated - import this from `typing` instead.
48	48	"ParseError",
49	49	"PathLike",
50	50	"PushInfo",
@@ -58,19 +58,19 @@
58	58	"RepositoryDirtyError",
59	59	"RootModule",
60	60	"RootUpdateProgress",
61		- "Sequence",
	61	+ "Sequence", # Deprecated - import this from `typing` instead.
62	62	"StageType",
63	63	"Stats",
64	64	"Submodule",
65	65	"SymbolicReference",
66		- "TYPE_CHECKING",
	66	+ "TYPE_CHECKING", # Deprecated - import this from `typing` instead.
67	67	"Tag",
68	68	"TagObject",
69	69	"TagReference",
70	70	"Tree",
71	71	"TreeModifier",
72		- "Tuple",
73		- "Union",
	72	+ "Tuple", # Deprecated - import this from `typing` instead.
	73	+ "Union", # Deprecated - import this from `typing` instead.
74	74	"UnmergedEntriesError",
75	75	"UnsafeOptionError",
76	76	"UnsafeProtocolError",

0 commit comments

Comments

0 (0)