From 592a864df23a4bf9029a431fb86f3928f684a563 Mon Sep 17 00:00:00 2001 From: akash5100 Date: Tue, 23 Aug 2022 14:24:02 +0530 Subject: [PATCH 1/3] rename datasource enum --- hvpy/datasources.py | 4 ++-- hvpy/tests/test_datasources.py | 4 ++-- hvpy/tests/test_utils.py | 16 ++++++++-------- hvpy/utils.py | 16 ++++++++-------- 4 files changed, 20 insertions(+), 20 deletions(-) diff --git a/hvpy/datasources.py b/hvpy/datasources.py index 60691f5..67bc870 100644 --- a/hvpy/datasources.py +++ b/hvpy/datasources.py @@ -1,9 +1,9 @@ from enum import Enum -__all__ = ["DataSources"] +__all__ = ["DataSource"] -class DataSources(Enum): +class DataSource(Enum): """ Enum for datasources hosted by the Helioviewer Project. """ diff --git a/hvpy/tests/test_datasources.py b/hvpy/tests/test_datasources.py index 804a5dd..4aec571 100644 --- a/hvpy/tests/test_datasources.py +++ b/hvpy/tests/test_datasources.py @@ -1,6 +1,6 @@ from typing import Any -from hvpy import DataSources, getDataSources +from hvpy import DataSource, getDataSources def find_nested_keys(obj: dict, key: Any, out: list): @@ -24,7 +24,7 @@ def find_nested_keys(obj: dict, key: Any, out: list): def test_datasources(): source_ids = [] - enum_values = [s_id.value for s_id in DataSources] + enum_values = [s_id.value for s_id in DataSource] response = getDataSources() find_nested_keys(response, "sourceId", source_ids) for source_id in source_ids: diff --git a/hvpy/tests/test_utils.py b/hvpy/tests/test_utils.py index e77dfe1..7f3d93a 100644 --- a/hvpy/tests/test_utils.py +++ b/hvpy/tests/test_utils.py @@ -1,13 +1,13 @@ import pytest -from hvpy import DataSources +from hvpy import DataSource from hvpy.utils import _create_layer_string, _to_datasource, create_layers def test_create_layers(): assert create_layers([(9, 100), (11, 50)]) == "[9,1,100],[11,1,50]" - with pytest.raises(ValueError, match="999 is not a valid DataSources"): + with pytest.raises(ValueError, match="999 is not a valid DataSource"): create_layers([(9, 100), (999, 100)]) with pytest.raises(ValueError, match="must be between 0 and 100"): @@ -18,15 +18,15 @@ def test_create_layers(): def test_to_datasource(): - assert _to_datasource(9) == DataSources.AIA_131 - assert _to_datasource(DataSources.AIA_94) == DataSources.AIA_94 - with pytest.raises(ValueError, match="999 is not a valid DataSources"): + assert _to_datasource(9) == DataSource.AIA_131 + assert _to_datasource(DataSource.AIA_94) == DataSource.AIA_94 + with pytest.raises(ValueError, match="999 is not a valid DataSource"): _to_datasource(999) def test_create_layers_string(): - assert _create_layer_string(DataSources.AIA_131, 100) == "[9,1,100]" + assert _create_layer_string(DataSource.AIA_131, 100) == "[9,1,100]" with pytest.raises(ValueError, match="must be between 0 and 100"): - _create_layer_string(DataSources.AIA_131, 101) + _create_layer_string(DataSource.AIA_131, 101) with pytest.raises(ValueError, match="must be between 0 and 100"): - _create_layer_string(DataSources.AIA_131, -1) + _create_layer_string(DataSource.AIA_131, -1) diff --git a/hvpy/utils.py b/hvpy/utils.py index 3b69c2b..c4f3cf4 100644 --- a/hvpy/utils.py +++ b/hvpy/utils.py @@ -1,7 +1,7 @@ from typing import Any, Union, Callable from datetime import datetime -from hvpy.datasources import DataSources +from hvpy.datasources import DataSource __all__ = [ "convert_date_to_isoformat", @@ -37,19 +37,19 @@ def convert_date_to_unix(v: list) -> str: return ",".join([str(int(datetime.timestamp(d))) for d in v]) -def _to_datasource(val: Union[int, DataSources]) -> DataSources: +def _to_datasource(val: Union[int, DataSource]) -> DataSource: """ - Validates the input and converts it to a DataSources enum. + Validates the input and converts it to a DataSource enum. """ - if isinstance(val, int) and val in [x.value for x in DataSources]: - return DataSources(val) - elif isinstance(val, DataSources): + if isinstance(val, int) and val in [x.value for x in DataSource]: + return DataSource(val) + elif isinstance(val, DataSource): return val else: - raise ValueError(f"{val} is not a valid DataSources") + raise ValueError(f"{val} is not a valid DataSource") -def _create_layer_string(source_id: DataSources, opacity: int) -> str: +def _create_layer_string(source_id: DataSource, opacity: int) -> str: """ Generates a string of the form "[source_id,1,opacity]" for a layer. """ From 2db91635ab4462e8deca6f19603be69355dd4967 Mon Sep 17 00:00:00 2001 From: akash5100 Date: Tue, 23 Aug 2022 14:32:36 +0530 Subject: [PATCH 2/3] rename datasources module to datasource --- hvpy/__init__.py | 2 +- hvpy/{datasources.py => datasource.py} | 0 hvpy/utils.py | 2 +- 3 files changed, 2 insertions(+), 2 deletions(-) rename hvpy/{datasources.py => datasource.py} (100%) diff --git a/hvpy/__init__.py b/hvpy/__init__.py index 31a778c..7aebce3 100644 --- a/hvpy/__init__.py +++ b/hvpy/__init__.py @@ -1,5 +1,5 @@ from .facade import * from .config import set_api_url from .version import __version__ -from .datasources import * +from .datasource import * from .utils import create_layers diff --git a/hvpy/datasources.py b/hvpy/datasource.py similarity index 100% rename from hvpy/datasources.py rename to hvpy/datasource.py diff --git a/hvpy/utils.py b/hvpy/utils.py index c4f3cf4..4956f39 100644 --- a/hvpy/utils.py +++ b/hvpy/utils.py @@ -1,7 +1,7 @@ from typing import Any, Union, Callable from datetime import datetime -from hvpy.datasources import DataSource +from hvpy.datasource import DataSource __all__ = [ "convert_date_to_isoformat", From 6938daa9b82c1ca99b6825878d55e55153f56c45 Mon Sep 17 00:00:00 2001 From: akash5100 Date: Tue, 23 Aug 2022 14:38:34 +0530 Subject: [PATCH 3/3] Fix documentation build failure --- docs/api.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api.rst b/docs/api.rst index d983f92..3094f86 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -13,7 +13,7 @@ API Reference .. automodapi:: hvpy.parameters :allowed-package-names: hvpy.api_groups -.. automodapi:: hvpy.datasources +.. automodapi:: hvpy.datasource :no-inheritance-diagram: .. automodapi:: hvpy.utils