Commit26dccd7

committed

Streamline setup.py file reading

This is partly a refactoring, reducing logic duplication andslightly decreasing overall length of the code that reads valuesfrom files. However, it does make two small behavioral changes:- In addition to the VERSION file for which this was already the case, requirements files and the readme are also taken relative to the directory that contains the setup.py file, rather than relative to the current directory if different. Supporting reading the readme and dependencies realtive to a different directory doesn't seem intended, and could lead to confusion in some cases.- The VERSION file is now read entirely and whitespace stripped, rather than reading just the first line. The VERSION file should always contain exactly one line, and this logic is simpler.This changes code for the reading of metadata only. It does notmake any changes to the version stamping code.

1 parent1b43166 commit26dccd7Copy full SHA for 26dccd7

File tree

1 file changed

-11

lines changed

setup.py

1 file changed

-11

lines changed

`‎setup.py`

Lines changed: 9 additions & 11 deletions

Original file line number	Diff line number	Diff line change
`@@ -2,24 +2,22 @@`
`2`	`2`
`3`	`3`	`importos`
`4`	`4`	`importsys`
	`5`	`+frompathlibimportPath`
`5`	`6`	`fromtypingimportSequence`
`6`	`7`
`7`	`8`	`fromsetuptoolsimportsetup,find_packages`
`8`	`9`	`fromsetuptools.command.build_pyimportbuild_pyas_build_py`
`9`	`10`	`fromsetuptools.command.sdistimportsdistas_sdist`
`10`	`11`
`11`	`12`
`12`		`-withopen(os.path.join(os.path.dirname(__file__),"VERSION"),encoding="utf-8")asver_file:`
`13`		`-VERSION=ver_file.readline().strip()`
	`13`	`+def_read_content(path:str)->str:`
	`14`	`+return (Path(__file__).parent/path).read_text(encoding="utf-8")`
`14`	`15`
`15`		`-withopen("requirements.txt",encoding="utf-8")asreqs_file:`
`16`		`-requirements=reqs_file.read().splitlines()`
`17`	`16`
`18`		`-withopen("test-requirements.txt",encoding="utf-8")asreqs_file:`
`19`		`-test_requirements=reqs_file.read().splitlines()`
`20`		`-`
`21`		`-withopen("README.md",encoding="utf-8")asrm_file:`
`22`		`-long_description=rm_file.read()`
	`17`	`+version=_read_content("VERSION").strip()`
	`18`	`+requirements=_read_content("requirements.txt").splitlines()`
	`19`	`+test_requirements=_read_content("test-requirements.txt").splitlines()`
	`20`	`+long_description=_read_content("README.md")`
`23`	`21`
`24`	`22`
`25`	`23`	`classbuild_py(_build_py):`
`@@ -50,7 +48,7 @@ def _stamp_version(filename: str) -> None:`
`50`	`48`	`withopen(filename)asf:`
`51`	`49`	`forlineinf:`
`52`	`50`	`if"__version__ ="inline:`
`53`		`-line=line.replace('"git"',"'%s'"%VERSION)`
	`51`	`+line=line.replace('"git"',"'%s'"%version)`
`54`	`52`	`found=True`
`55`	`53`	`out.append(line)`
`56`	`54`	`exceptOSError:`
`@@ -66,7 +64,7 @@ def _stamp_version(filename: str) -> None:`
`66`	`64`	`setup(`
`67`	`65`	`name="GitPython",`
`68`	`66`	`cmdclass={"build_py":build_py,"sdist":sdist},`
`69`		`-version=VERSION,`
	`67`	`+version=version,`
`70`	`68`	`description="GitPython is a Python library used to interact with Git repositories",`
`71`	`69`	`author="Sebastian Thiel, Michael Trier",`
`72`	`70`	`author_email="byronimo@gmail.com, mtrier@gmail.com",`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commit26dccd7

File tree

1 file changed

1 file changed

`‎setup.py`

0 commit comments