Skip to content

Commit 3856273

Browse files
julianjanssenbuddemat
authored andcommitted
Remove tailing whitespace in varios classes of docstrings in cadenzaanyltics
1 parent f0ac52b commit 3856273

File tree

8 files changed

+16
-16
lines changed

8 files changed

+16
-16
lines changed

src/cadenzaanalytics/cadenza_analytics_extension.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,4 +102,4 @@ def _get_request_data(self, multipart_request) -> AnalyticsRequest:
102102
else:
103103
df_data = pd.DataFrame()
104104

105-
return AnalyticsRequest(metadata, df_data)
105+
return AnalyticsRequest(metadata, df_data)

src/cadenzaanalytics/cadenza_analytics_extension_service.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ def add_analytics_extension(self, analytics_extension: CadenzaAnalyticsExtension
2626
----------
2727
analytics_extension : CadenzaAnalyticsExtension
2828
The analytics extension to be added.
29-
"""
29+
"""
3030
self._analytics_extensions.append(analytics_extension)
3131

3232
self._app.add_url_rule("/" + analytics_extension.relative_path,
@@ -45,7 +45,7 @@ def run_development_server(self, port: int = 5000):
4545
----------
4646
port : int, optional
4747
The port where the service is exposed, default 5000.
48-
"""
48+
"""
4949
self._app.run(port=port)
5050

5151
def __call__(self, *args, **kwargs):

src/cadenzaanalytics/request/analytics_request.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
class AnalyticsRequest:
55
"""A class representing an analytics request.
6-
"""
6+
"""
77
def __init__(self, metadata: RequestMetadata, data):
88
self._metadata = metadata
99
self._data = data
@@ -16,7 +16,7 @@ def metadata(self) -> RequestMetadata:
1616
-------
1717
RequestMetadata
1818
The metadata associated with the request.
19-
"""
19+
"""
2020
return self._metadata
2121

2222
@property
@@ -27,5 +27,5 @@ def data(self):
2727
-------
2828
object
2929
The data associated with the request.
30-
"""
30+
"""
3131
return self._data

src/cadenzaanalytics/request/request_metadata.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ def get_first_column_of_attribute_group(self, attribute_group) -> Optional[Colum
3737
-------
3838
Optional[ColumnMetadata]
3939
The column metadata of the first column in the given attribute group. If no column metadata for the attribute group was send None is returned.
40-
"""
40+
"""
4141
if self.has_columns():
4242
for column in self._get_columns():
4343
if column['attributeGroupName'] == attribute_group:
@@ -51,7 +51,7 @@ def get_columns_by_attribute_group(self) -> Dict[str, List[ColumnMetadata]]:
5151
-------
5252
Dict[str, List[ColumnMetadata]]
5353
A dictionary where the keys are the attribute group names and values are lists of corresponding column metadata objects.
54-
"""
54+
"""
5555
grouped_columns = {}
5656
columns = self._get_columns() if self.has_columns() else []
5757
for column in columns:
@@ -69,7 +69,7 @@ def get_columns(self) -> List[ColumnMetadata]:
6969
-------
7070
List[ColumnMetadata]
7171
A list of all column metadata objects.
72-
"""
72+
"""
7373
columns = self._get_columns() if self.has_columns() else []
7474
return [ColumnMetadata._from_dict(column) for column in columns]
7575

@@ -80,7 +80,7 @@ def get_parameters(self) -> Dict[str, str]:
8080
-------
8181
dict[str, str]
8282
Parameters of the request.
83-
"""
83+
"""
8484
return self._request_metadata['parameters']
8585

8686
def get_parameter(self, name: str) -> Optional[str]:
@@ -107,7 +107,7 @@ def has_columns(self) -> bool:
107107
-------
108108
bool
109109
True if the request has columns with coresponding metadata, False otherwise.
110-
"""
110+
"""
111111
return (len(self._request_metadata['dataContainers']) > 0
112112
and "columns" in self._request_metadata['dataContainers'][0])
113113

src/cadenzaanalytics/response/csv_response.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ def get_response(self, original_column_metadata: List[ColumnMetadata], original_
3030
-------
3131
Response
3232
The CSV response.
33-
"""
33+
"""
3434
python_3_12 = (3, 12)
3535
if sys.version_info >= python_3_12:
3636
csv_data = self._data.to_csv(

src/cadenzaanalytics/response/error_response.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ class ErrorResponse(ExtensionResponse):
1515
----------
1616
ExtensionResponse : type
1717
The base extension response type from which ErrorResponse inherits.
18-
"""
18+
"""
1919
def __init__(self, message: str, status: int = 400):
2020
self._message = message
2121
self._status = status
@@ -27,7 +27,7 @@ def get_response(self, original_column_metadata: List[ColumnMetadata], original_
2727
-------
2828
Response
2929
The error response.
30-
"""
30+
"""
3131
return self._create_response(self._message)
3232

3333
def _get_response_json(self, message: str):

src/cadenzaanalytics/response/extension_data_response.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ class ExtensionDataResponse(ExtensionResponse):
1515
----------
1616
ExtensionResponse : type
1717
The base extension response type from which ExtensionDataResponse inherits.
18-
"""
18+
"""
1919
def __init__(self, content_type, data_container_name='response-data'):
2020
self._content_type = content_type
2121
self._data_container_name = data_container_name

src/cadenzaanalytics/response/extension_response.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@ class ExtensionResponse:
1010
"""
1111
def get_response(self, original_column_metadata: List[ColumnMetadata], original_data: DataFrame):
1212
"""Get the response from the extension.
13-
"""
13+
"""
1414
pass

0 commit comments

Comments
 (0)