Skip to content

Commit 31ff730

Browse files
zFernand0zFernand0
committed
chore: fix pydoclint warnings 😋
Signed-off-by: Fernando Rijo Cedeno <37381190+zFernand0@users.noreply.github.com>
1 parent 24102f6 commit 31ff730

9 files changed

Lines changed: 154 additions & 17 deletions

File tree

‎pyproject.toml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,4 @@ style = "numpy"
1313
check-arg-order = false
1414
require-return-section-when-returning-nothing = false
1515
quiet = true
16+
exclude = "build|response"

‎src/workflows/zowe/workflows_for_zowe_sdk/response/workflows.py‎

Lines changed: 64 additions & 16 deletions
Large diffs are not rendered by default.

‎src/zos_console/zowe/zos_console_for_zowe_sdk/response/console.py‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616

1717
@dataclass
1818
class IssueCommandResponse:
19+
"""Issue command response dataclass."""
20+
1921
cmd_response_key: Optional[str] = None
2022
cmd_response_url: Optional[str] = None
2123
cmd_response_uri: Optional[str] = None
@@ -27,14 +29,18 @@ def __init__(self, response: dict[str, Any]) -> None:
2729
super().__setattr__(key, value)
2830

2931
def __getitem__(self, key: str) -> str:
32+
"""Get item by key."""
3033
return str(self.__dict__[key.replace("-", "_")])
3134

3235
def __setitem__(self, key: str, value: str) -> None:
36+
"""Set item by key."""
3337
self.__dict__[key.replace("-", "_")] = value
3438

3539

3640
@dataclass
3741
class ConsoleResponse:
42+
"""Console response dataclass."""
43+
3844
cmd_response: Optional[str] = None
3945
sol_key_detected: Optional[bool] = None
4046

@@ -44,7 +50,9 @@ def __init__(self, response: dict[str, Any]) -> None:
4450
super().__setattr__(key, value)
4551

4652
def __getitem__(self, key: str) -> Any:
53+
"""Get item by key."""
4754
return self.__dict__[key.replace("-", "_")]
4855

4956
def __setitem__(self, key: str, value: Any) -> None:
57+
"""Set item by key."""
5058
self.__dict__[key.replace("-", "_")] = value

‎src/zos_files/zowe/zos_files_for_zowe_sdk/response/datasets.py‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616

1717
@dataclass
1818
class DatasetListResponse:
19+
"""Dataset list response dataclass."""
20+
1921
items: Optional[list["DatasetResponse"] | list["SimpleDatasetResponse"]] = None
2022
returnedRows: Optional[int] = None
2123
totalRows: Optional[int] = None
@@ -30,25 +32,33 @@ def __init__(self, response: dict[str, Any], attributes: bool) -> None:
3032
super().__setattr__(key, value)
3133

3234
def __getitem__(self, key: str) -> Any:
35+
"""Get item by key."""
3336
return self.__dict__[key]
3437

3538
def __setitem__(self, key: str, value: Any) -> None:
39+
"""Set item by key."""
3640
self.__dict__[key] = value
3741

3842

3943
@dataclass
4044
class SimpleDatasetResponse:
45+
"""Simple dataset response dataclass."""
46+
4147
dsname: Optional[str] = None
4248

4349
def __getitem__(self, key: str) -> Any:
50+
"""Get item by key."""
4451
return self.__dict__[key]
4552

4653
def __setitem__(self, key: str, value: Any) -> None:
54+
"""Set item by key."""
4755
self.__dict__[key] = value
4856

4957

5058
@dataclass
5159
class DatasetResponse:
60+
"""Dataset response dataclass."""
61+
5262
dsname: Optional[str] = None
5363
blksz: Optional[str] = None
5464
catnm: Optional[str] = None
@@ -71,14 +81,18 @@ class DatasetResponse:
7181
dsntp: Optional[str] = None
7282

7383
def __getitem__(self, key: str) -> Any:
84+
"""Get item by key."""
7485
return self.__dict__[key]
7586

7687
def __setitem__(self, key: str, value: Any) -> None:
88+
"""Set item by key."""
7789
self.__dict__[key] = value
7890

7991

8092
@dataclass
8193
class MemberListResponse:
94+
"""Member list response dataclass."""
95+
8296
items: Optional[list[dict[str, Any]]] = None
8397
totalRows: Optional[int] = None
8498
JSONversion: Optional[int] = None
@@ -92,25 +106,33 @@ def __init__(self, response: dict[str, Any], attributes: bool) -> None:
92106
super().__setattr__(key, value)
93107

94108
def __getitem__(self, key: str) -> Any:
109+
"""Get item by key."""
95110
return self.__dict__[key]
96111

97112
def __setitem__(self, key: str, value: Any) -> None:
113+
"""Set item by key."""
98114
self.__dict__[key] = value
99115

100116

101117
@dataclass
102118
class SimpleMemberResponse:
119+
"""Simple member response dataclass."""
120+
103121
member: Optional[str] = None
104122

105123
def __getitem__(self, key: str) -> Any:
124+
"""Get item by key."""
106125
return self.__dict__[key]
107126

108127
def __setitem__(self, key: str, value: Any) -> None:
128+
"""Set item by key."""
109129
self.__dict__[key] = value
110130

111131

112132
@dataclass
113133
class MemberResponse:
134+
"""Member response dataclass."""
135+
114136
member: Optional[str] = None
115137
vers: Optional[int] = None
116138
mod: Optional[int] = None
@@ -125,7 +147,9 @@ class MemberResponse:
125147
sclm: Optional[str] = None
126148

127149
def __getitem__(self, key: str) -> Any:
150+
"""Get item by key."""
128151
return self.__dict__[key]
129152

130153
def __setitem__(self, key: str, value: Any) -> None:
154+
"""Set item by key."""
131155
self.__dict__[key] = value

‎src/zos_files/zowe/zos_files_for_zowe_sdk/response/file_system.py‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616

1717
@dataclass
1818
class FileSystemResponse:
19+
"""File system response dataclass."""
20+
1921
name: Optional[str] = None
2022
mountpoint: Optional[str] = None
2123
fstname: Optional[str] = None
@@ -33,14 +35,18 @@ class FileSystemResponse:
3335
mountparm: Optional[str] = None
3436

3537
def __getitem__(self, key: str) -> Any:
38+
"""Get item by key."""
3639
return self.__dict__[key]
3740

3841
def __setitem__(self, key: str, value: Any) -> None:
42+
"""Set item by key."""
3943
self.__dict__[key] = value
4044

4145

4246
@dataclass
4347
class FileSystemListResponse:
48+
"""File system list response dataclass."""
49+
4450
items: Optional[list[FileSystemResponse]] = None
4551
returnedRows: Optional[int] = None
4652
totalRows: Optional[int] = None
@@ -53,7 +59,9 @@ def __init__(self, response: dict[str, Any]) -> None:
5359
super().__setattr__(key, value)
5460

5561
def __getitem__(self, key: str) -> Any:
62+
"""Get item by key."""
5663
return self.__dict__[key]
5764

5865
def __setitem__(self, key: str, value: Any) -> None:
66+
"""Set item by key."""
5967
self.__dict__[key] = value

‎src/zos_files/zowe/zos_files_for_zowe_sdk/response/uss.py‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@
1717

1818
@dataclass
1919
class USSResponse:
20+
"""USS response dataclass."""
21+
2022
name: Optional[str] = None
2123
mode: Optional[str] = None
2224
size: Optional[int] = None
@@ -27,14 +29,18 @@ class USSResponse:
2729
mtime: Optional[str] = None
2830

2931
def __getitem__(self, key: str) -> Any:
32+
"""Get item by key."""
3033
return self.__dict__[key]
3134

3235
def __setitem__(self, key: str, value: Any) -> None:
36+
"""Set item by key."""
3337
self.__dict__[key] = value
3438

3539

3640
@dataclass
3741
class USSListResponse:
42+
"""USS list response dataclass."""
43+
3844
items: Optional[list[USSResponse]] = None
3945
returnedRows: Optional[int] = None
4046
totalRows: Optional[int] = None
@@ -47,20 +53,24 @@ def __init__(self, response: dict[str, Any]) -> None:
4753
super().__setattr__(key, value)
4854

4955
def __getitem__(self, key: str) -> Any:
56+
"""Get item by key."""
5057
return self.__dict__[key]
5158

5259
def __setitem__(self, key: str, value: Any) -> None:
60+
"""Set item by key."""
5361
self.__dict__[key] = value
5462

5563

5664
class USSFileTagType(Enum):
65+
"""USS file tag type enumeration."""
66+
5767
TEXT = "t"
5868
BINARY = "b"
5969
MIXED = "m"
6070

6171
@classmethod
6272
def from_string(cls, value: str) -> Optional['USSFileTagType']:
63-
"""Convert string to enum, return None if not valid"""
73+
"""Convert string to enum, return None if not valid."""
6474
for tag_type in cls:
6575
if tag_type.value == value:
6676
return tag_type
@@ -69,6 +79,8 @@ def from_string(cls, value: str) -> Optional['USSFileTagType']:
6979

7080
@dataclass
7181
class USSFileTag:
82+
"""USS file tag dataclass."""
83+
7284
tag_type: Optional['USSFileTagType'] = None
7385
charset: Optional[str] = None
7486
is_conversion_enabled: Optional[bool] = None
@@ -92,7 +104,9 @@ def __init__(self, response: dict[str, Any]) -> None:
92104
raise Exception("Unknown response from 'chtag list': {}".format(response))
93105

94106
def __getitem__(self, key: str) -> Any:
107+
"""Get item by key."""
95108
return self.__dict__[key]
96109

97110
def __setitem__(self, key: str, value: Any) -> None:
111+
"""Set item by key."""
98112
self.__dict__[key] = value

‎src/zos_jobs/zowe/zos_jobs_for_zowe_sdk/response/jobs.py‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616

1717
@dataclass
1818
class JobResponse:
19+
"""Job response dataclass."""
20+
1921
owner: Optional[str] = None
2022
phase: Optional[int] = None
2123
subsystem: Optional[str] = None
@@ -38,18 +40,22 @@ def __init__(self, response: dict[str, Any]) -> None:
3840
super().__setattr__(key, value)
3941

4042
def __getitem__(self, key: str) -> Any:
43+
"""Get item by key."""
4144
if key == "class":
4245
key = "job_class"
4346
return self.__dict__[key.replace("-", "_")]
4447

4548
def __setitem__(self, key: str, value: Any) -> None:
49+
"""Set item by key."""
4650
if key == "class":
4751
key = "job_class"
4852
self.__dict__[key.replace("-", "_")] = value
4953

5054

5155
@dataclass
5256
class StatusResponse:
57+
"""Job status response dataclass."""
58+
5359
owner: Optional[str] = None
5460
jobid: Optional[str] = None
5561
job_correlator: Optional[str] = None
@@ -64,14 +70,18 @@ def __init__(self, response: dict[str, Any]) -> None:
6470
super().__setattr__(key, value)
6571

6672
def __getitem__(self, key: str) -> Any:
73+
"""Get item by key."""
6774
return self.__dict__[key.replace("-", "_")]
6875

6976
def __setitem__(self, key: str, value: Any) -> None:
77+
"""Set item by key."""
7078
self.__dict__[key.replace("-", "_")] = value
7179

7280

7381
@dataclass
7482
class SpoolResponse:
83+
"""Spool file response dataclass."""
84+
7585
recfm: Optional[str] = None
7686
records_url: Optional[str] = None
7787
stepname: Optional[str] = None
@@ -95,11 +105,13 @@ def __init__(self, response: dict[str, Any]) -> None:
95105
super().__setattr__(key, value)
96106

97107
def __getitem__(self, key: str) -> Any:
108+
"""Get item by key."""
98109
if key == "class":
99110
key = "job_class"
100111
return self.__dict__[key.replace("-", "_")]
101112

102113
def __setitem__(self, key: str, value: Any) -> None:
114+
"""Set item by key."""
103115
if key == "class":
104116
key = "job_class"
105117
self.__dict__[key.replace("-", "_")] = value

‎src/zos_tso/zowe/zos_tso_for_zowe_sdk/response/tso.py‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616

1717
@dataclass
1818
class StartResponse:
19+
"""TSO start response dataclass."""
20+
1921
servletKey: str
2022
queueID: Optional[str] = None
2123
sessionID: Optional[str] = None
@@ -25,14 +27,18 @@ class StartResponse:
2527
timeout: Optional[bool] = None
2628

2729
def __getitem__(self, key: str) -> Any:
30+
"""Get item by key."""
2831
return self.__dict__[key]
2932

3033
def __setitem__(self, key: str, value: Any) -> None:
34+
"""Set item by key."""
3135
self.__dict__[key] = value
3236

3337

3438
@dataclass
3539
class EndResponse:
40+
"""TSO end response dataclass."""
41+
3642
servletKey: str
3743
msgId: list[str] = field(default_factory=list)
3844
ver: Optional[str] = None
@@ -41,29 +47,37 @@ class EndResponse:
4147
msgData: Optional[str] = None
4248

4349
def __getitem__(self, key: str) -> Any:
50+
"""Get item by key."""
4451
return self.__dict__[key]
4552

4653
def __setitem__(self, key: str, value: Any) -> None:
54+
"""Set item by key."""
4755
self.__dict__[key] = value
4856

4957

5058
@dataclass
5159
class SendResponse:
60+
"""TSO send response dataclass."""
61+
5262
servletKey: str
5363
tsoData: Optional[list[dict[str, Any]]] = None
5464
ver: Optional[str] = None
5565
reused: Optional[bool] = None
5666
timeout: Optional[bool] = None
5767

5868
def __getitem__(self, key: str) -> Any:
69+
"""Get item by key."""
5970
return self.__dict__[key]
6071

6172
def __setitem__(self, key: str, value: Any) -> None:
73+
"""Set item by key."""
6274
self.__dict__[key] = value
6375

6476

6577
@dataclass
6678
class IssueResponse:
79+
"""TSO issue response dataclass."""
80+
6781
start_response: StartResponse
6882
send_response: SendResponse
6983
end_response: EndResponse

0 commit comments

Comments
 (0)