René's URL Explorer Experiment

Title: Refactor Git.{AutoInterrupt,CatFileContentStream} nesting by EliahKagan · Pull Request #2037 · gitpython-developers/GitPython · GitHub

Open Graph Title: Refactor Git.{AutoInterrupt,CatFileContentStream} nesting by EliahKagan · Pull Request #2037 · gitpython-developers/GitPython

X Title: Refactor Git.{AutoInterrupt,CatFileContentStream} nesting by EliahKagan · Pull Request #2037 · gitpython-developers/GitPython

Description: This makes Git.AutoInterrupt and Git.CatFileContentStream transparent aliases to top-level nonpublic _AutoInterrupt and _CatFileContentStream classes in the cmd module. This does not change the "public" interface. It also does not change metadata relevant to documentation: the __name__ and __qualname__ attributes are set explicitly to the values they had before when these classes were defined nested, so that Sphinx continues to document them (and to do so in full) in Git and as Git.AutoInterrupt and Git.CatFileContentStream. The purpose of this is to increase readability. The Git class is big and complex, with a number of long members and various forms of nesting. Since these two classes can be understood even without reading the code of the Git class, moving the definitions out of the Git class into top-level nonpublic classes will hopefully increase readability and help with maintenance. I originally intended this as just the first commit of several. But I realized that change is probably the only one that might be controversial. So I figured I'd open a PR for it by itself. In my view: The flatter layout and physical separation makes for easier reading and emphasizes that, even as they are nested classes of the Git class as far as the interface is concerned, these classes are uses by the Git and do not themselves use the Git class. The conceptual burden of setting __name__ and __qualname__ to make Sphinx continue working as desired (while still having the metadata at runtime the same as Sphinx claims) is not too big of a conceptual burden. But whether this is better is a subjective question, so I figured it would be good to get a review. I have verified that the intended effect in Sphinx documentation--the effect that the classes continue to be presented, in full, as nested classes of Git, just as they may (and should!) continue to be used when they are accessed both within GitPython and by other code that uses GitPython--is what we get. Specifically: I observed this locally, and It can be seen in the readthedocs cloud build for this PR, for Git.AutoInterrupt and Git.CatFileContentStream. (They can be compared to the latest release versions of the Git.AutoInterrupt and Git.CatFileContentStream classes.)

Open Graph Description: This makes Git.AutoInterrupt and Git.CatFileContentStream transparent aliases to top-level nonpublic _AutoInterrupt and _CatFileContentStream classes in the cmd module. This does not change the &qu...

X Description: This makes Git.AutoInterrupt and Git.CatFileContentStream transparent aliases to top-level nonpublic _AutoInterrupt and _CatFileContentStream classes in the cmd module. This does not change the &am...

Opengraph URL: https://github.com/gitpython-developers/GitPython/pull/2037

X: @github

direct link

Domain: github.com

Links:

Viewport: width=device-width