Skip to content

Commit 437b568

Browse files
committed
test: packageinfo
1 parent cee0115 commit 437b568

File tree

8 files changed

+1736
-48
lines changed

8 files changed

+1736
-48
lines changed

documentation/reference/licensecheck/packageinfo.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -7,71 +7,71 @@ Packageinfo
77
> Auto-generated documentation for [licensecheck.packageinfo](../../../licensecheck/packageinfo.py) module.
88
99
- [Packageinfo](#packageinfo)
10-
- [getClassifiersLicense](#getclassifierslicense)
1110
- [getModuleSize](#getmodulesize)
1211
- [getMyPackageLicense](#getmypackagelicense)
12+
- [getMyPackageMetadata](#getmypackagemetadata)
1313
- [getPackageInfoLocal](#getpackageinfolocal)
1414
- [getPackageInfoPypi](#getpackageinfopypi)
1515
- [getPackages](#getpackages)
1616
- [licenseFromClassifierlist](#licensefromclassifierlist)
1717

18-
## getClassifiersLicense
18+
## getModuleSize
19+
20+
[Show source in packageinfo.py:160](../../../licensecheck/packageinfo.py#L160)
1921

20-
[Show source in packageinfo.py:121](../../../licensecheck/packageinfo.py#L121)
22+
Get the size of a given module as an int.
2123

22-
Get the package classifiers and license from "setup.cfg", "pyproject.toml" or user input
24+
#### Arguments
25+
26+
- `path` *Path* - path to package
27+
- `name` *str* - name of package
2328

2429
#### Returns
2530

26-
- `dict[str,` *Any]* - {"classifiers": set[str], "license": str}
31+
- `int` - size in bytes
2732

2833
#### Signature
2934

3035
```python
31-
def getClassifiersLicense() -> dict[str, Any]:
36+
def getModuleSize(path: Path, name: str) -> int:
3237
...
3338
```
3439

3540

3641

37-
## getModuleSize
38-
39-
[Show source in packageinfo.py:163](../../../licensecheck/packageinfo.py#L163)
40-
41-
Get the size of a given module as an int.
42+
## getMyPackageLicense
4243

43-
#### Arguments
44+
[Show source in packageinfo.py:143](../../../licensecheck/packageinfo.py#L143)
4445

45-
- `path` *Path* - path to package
46-
- `name` *str* - name of package
46+
Get the package license from "setup.cfg", "pyproject.toml" or user input
4747

4848
#### Returns
4949

50-
- `int` - size in bytes
50+
- `str` - license name
5151

5252
#### Signature
5353

5454
```python
55-
def getModuleSize(path: Path, name: str) -> int:
55+
def getMyPackageLicense() -> str:
5656
...
5757
```
5858

5959

6060

61-
## getMyPackageLicense
61+
## getMyPackageMetadata
6262

63-
[Show source in packageinfo.py:145](../../../licensecheck/packageinfo.py#L145)
63+
[Show source in packageinfo.py:119](../../../licensecheck/packageinfo.py#L119)
6464

65-
Get the package license from "setup.cfg", "pyproject.toml" or user input
65+
Get the package classifiers and license from "setup.cfg", "pyproject.toml"
6666

6767
#### Returns
6868

69-
- `str` - license name
69+
- `dict[str,` *Any]* - {"classifiers": list[str], "license": str}
7070

7171
#### Signature
7272

7373
```python
74-
def getMyPackageLicense() -> str:
74+
def getMyPackageMetadata() -> dict[str, Any]:
7575
...
7676
```
7777

@@ -112,7 +112,7 @@ def getPackageInfoLocal(requirement: str) -> PackageInfo:
112112

113113
## getPackageInfoPypi
114114

115-
[Show source in packageinfo.py:55](../../../licensecheck/packageinfo.py#L55)
115+
[Show source in packageinfo.py:54](../../../licensecheck/packageinfo.py#L54)
116116

117117
Get package info from local files including version, author
118118
and the license.
@@ -145,7 +145,7 @@ def getPackageInfoPypi(requirement: str) -> PackageInfo:
145145

146146
## getPackages
147147

148-
[Show source in packageinfo.py:99](../../../licensecheck/packageinfo.py#L99)
148+
[Show source in packageinfo.py:97](../../../licensecheck/packageinfo.py#L97)
149149

150150
Get dependency info.
151151

@@ -172,7 +172,7 @@ def getPackages(reqs: set[str]) -> set[PackageInfo]:
172172

173173
## licenseFromClassifierlist
174174

175-
[Show source in packageinfo.py:81](../../../licensecheck/packageinfo.py#L81)
175+
[Show source in packageinfo.py:79](../../../licensecheck/packageinfo.py#L79)
176176

177177
Get license string from a list of project classifiers.
178178

documentation/reference/licensecheck/types.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Types
1212

1313
## License
1414

15-
[Show source in types.py:26](../../../licensecheck/types.py#L26)
15+
[Show source in types.py:29](../../../licensecheck/types.py#L29)
1616

1717
#### Attributes
1818

licensecheck/packageinfo.py

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -116,15 +116,15 @@ def getPackages(reqs: set[str]) -> set[PackageInfo]:
116116
return packageinfo
117117

118118

119-
def getClassifiersLicense() -> dict[str, Any]:
120-
"""Get the package classifiers and license from "setup.cfg", "pyproject.toml" or user input
119+
def getMyPackageMetadata() -> dict[str, Any]:
120+
"""Get the package classifiers and license from "setup.cfg", "pyproject.toml"
121121
122122
Returns:
123-
dict[str, Any]: {"classifiers": set[str], "license": str}
123+
dict[str, Any]: {"classifiers": list[str], "license": str}
124124
"""
125125
if Path("setup.cfg").exists():
126126
config = configparser.ConfigParser()
127-
_ = config.read("setup.cfg")
127+
config.read("setup.cfg")
128128
if "license" in config["metadata"]:
129129
return config["metadata"].__dict__
130130
if Path("pyproject.toml").exists():
@@ -146,16 +146,15 @@ def getMyPackageLicense() -> str:
146146
Returns:
147147
str: license name
148148
"""
149-
metaData = getClassifiersLicense()
149+
metaData = getMyPackageMetadata()
150150
licenseClassifier = licenseFromClassifierlist(metaData.get("classifiers", []))
151151
if licenseClassifier != UNKNOWN:
152152
return licenseClassifier
153153
if "license" in metaData:
154154
if isinstance(metaData["license"], dict) and metaData["license"].get("text") is not None:
155155
return str(metaData["license"].get("text"))
156-
else:
157-
return str(metaData["license"])
158-
return input("Enter the project license")
156+
return str(metaData["license"])
157+
return input("Enter the project license\n>")
159158

160159

161160
def getModuleSize(path: Path, name: str) -> int:

licensecheck/types.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ class PackageInfo:
1414

1515
name: str
1616
version: str = UNKNOWN
17-
namever: str = field(init=False)
17+
namever: str = field(init=False)
1818
size: int = -1
1919
homePage: str = UNKNOWN
2020
author: str = UNKNOWN

0 commit comments

Comments
 (0)