Skip to content

Commit

Permalink
docs: Hopefully fixes formatting in docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
@thorbjoernl
thorbjoernl committed Oct 1, 2024
1 parent d98878f commit bffd1ca
Showing 1 changed file with 61 additions and 60 deletions.
121 changes: 61 additions & 60 deletions src/aerovaldb/aerovaldb.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ async def get_glob_stats(
:param default: Default value that will be returned instead of raising FileNotFoundError
if not data was found (Will be returned as is and not converted to match access_type).
:returns : The fetched data.
:returns: The fetched data.
"""
raise NotImplementedError

Expand Down Expand Up @@ -193,7 +193,7 @@ async def get_heatmap(
:param default: Default value that will be returned instead of raising FileNotFoundError
if not data was found (Will be returned as is and not converted to match access_type).
:returns : The fetched data.
:returns: The fetched data.
"""
raise NotImplementedError

Expand Down Expand Up @@ -224,7 +224,7 @@ async def list_glob_stats(
:param project: str
:param experiment: str
:return List of URIs.
:return: List of URIs.
"""
raise NotImplementedError

Expand Down Expand Up @@ -255,7 +255,7 @@ async def get_contour(
:param default: Default value that will be returned instead of raising FileNotFoundError
if no data was found (Will be returned as is and not converted to match access_type).
:returns : The fetched data.
:returns: The fetched data.
"""
raise NotImplementedError

Expand Down Expand Up @@ -311,9 +311,9 @@ async def get_timeseries(
:param access_type: How the data is to be retrieved (See AccessType for details)
:param cache: Whether to use cache for this read.
:param default: Default value that will be returned instead of raising FileNotFoundError
if no data was found (Will be returned as is and not converted to match access_type).
if no data was found (Will be returned as is and not converted to match access_type).
:returns : The fetched data.
:returns: The fetched data.
"""
raise NotImplementedError

Expand Down Expand Up @@ -391,7 +391,7 @@ async def get_timeseries_weekly(
:param default: Default value that will be returned instead of raising FileNotFoundError
if not data was found (Will be returned as is and not converted to match access_type).
:returns : The fetched data.
:returns: The fetched data.
"""
raise NotImplementedError

Expand Down Expand Up @@ -443,7 +443,7 @@ async def get_experiments(
:param default: Default value that will be returned instead of raising FileNotFoundError
if not data was found (Will be returned as is and not converted to match access_type).
:returns : The fetched data.
:returns: The fetched data.
"""
raise NotImplementedError

Expand All @@ -459,8 +459,8 @@ async def put_experiments(self, obj, project: str, /, *args, **kwargs):
def rm_experiment_data(self, project: str, experiment: str):
"""Deletes ALL data associated with an experiment.
:param project : Project ID.
:param experiment : Experiment ID.
:param project: Project ID.
:param experiment: Experiment ID.
"""
raise NotImplementedError

Expand Down Expand Up @@ -490,9 +490,9 @@ async def get_config(
:param access_type: How the data is to be retrieved (See AccessType for details)
:param cache: Whether to use cache for this read.
:param default: Default value that will be returned instead of raising FileNotFoundError
if not data was found (Will be returned as is and not converted to match access_type).
if not data was found (Will be returned as is and not converted to match access_type).
:returns : The fetched data.
:returns: The fetched data.
"""
raise NotImplementedError

Expand Down Expand Up @@ -531,7 +531,7 @@ async def get_menu(
:param default: Default value that will be returned instead of raising FileNotFoundError
if not data was found (Will be returned as is and not converted to match access_type).
:returns : The fetched data.
:returns: The fetched data.
"""
raise NotImplementedError

Expand Down Expand Up @@ -567,9 +567,9 @@ async def get_statistics(
:param access_type: How the data is to be retrieved (See AccessType for details)
:param cache: Whether to use cache for this read.
:param default: Default value that will be returned instead of raising FileNotFoundError
if not data was found (Will be returned as is and not converted to match access_type).
if not data was found (Will be returned as is and not converted to match access_type).
:returns : The fetched data.
:returns: The fetched data.
"""
raise NotImplementedError

Expand Down Expand Up @@ -607,9 +607,9 @@ async def get_ranges(
:param access_type: How the data is to be retrieved (See AccessType for details)
:param cache: Whether to use cache for this read.
:param default: Default value that will be returned instead of raising FileNotFoundError
if not data was found (Will be returned as is and not converted to match access_type).
if not data was found (Will be returned as is and not converted to match access_type).
:returns : The fetched data.
:returns: The fetched data.
"""
raise NotImplementedError

Expand Down Expand Up @@ -645,9 +645,9 @@ async def get_regions(
:param access_type: How the data is to be retrieved (See AccessType for details)
:param cache: Whether to use cache for this read.
:param default: Default value that will be returned instead of raising FileNotFoundError
if not data was found (Will be returned as is and not converted to match access_type).
if not data was found (Will be returned as is and not converted to match access_type).
:returns : The fetched data.
:returns: The fetched data.
"""
raise NotImplementedError

Expand Down Expand Up @@ -683,9 +683,9 @@ async def get_models_style(
:param access_type: How the data is to be retrieved (See AccessType for details)
:param cache: Whether to use cache for this read.
:param default: Default value that will be returned instead of raising FileNotFoundError
if not data was found (Will be returned as is and not converted to match access_type).
if not data was found (Will be returned as is and not converted to match access_type).
:returns : The fetched data.
:returns: The fetched data.
"""
raise NotImplementedError

Expand Down Expand Up @@ -735,9 +735,9 @@ async def get_map(
:param access_type: How the data is to be retrieved (See AccessType for details)
:param cache: Whether to use cache for this read.
:param default: Default value that will be returned instead of raising FileNotFoundError
if not data was found (Will be returned as is and not converted to match access_type).
if not data was found (Will be returned as is and not converted to match access_type).
:returns : The fetched data.
:returns: The fetched data.
"""
raise NotImplementedError

Expand Down Expand Up @@ -785,7 +785,7 @@ async def list_map(
:param project: The project ID.
:param experiment: The experiment ID.
:return List with the URIs.
:returns: List with the URIs.
"""
raise NotImplementedError

Expand Down Expand Up @@ -822,9 +822,9 @@ async def get_scatter(
:param access_type: How the data is to be retrieved (See AccessType for details)
:param cache: Whether to use cache for this read.
:param default: Default value that will be returned instead of raising FileNotFoundError
if not data was found (Will be returned as is and not converted to match access_type).
if not data was found (Will be returned as is and not converted to match access_type).
:returns : The fetched data.
:returns: The fetched data.
"""
raise NotImplementedError

Expand Down Expand Up @@ -886,9 +886,9 @@ async def get_profiles(
:param access_type: How the data is to be retrieved (See AccessType for details)
:param cache: Whether to use cache for this read.
:param default: Default value that will be returned instead of raising FileNotFoundError
if not data was found (Will be returned as is and not converted to match access_type).
if not data was found (Will be returned as is and not converted to match access_type).
:returns : The fetched data.
:returns: The fetched data.
"""
raise NotImplementedError

Expand Down Expand Up @@ -946,9 +946,9 @@ async def get_heatmap_timeseries(
:param access_type: How the data is to be retrieved (See AccessType for details)
:param cache: Whether to use cache for this read.
:param default: Default value that will be returned instead of raising FileNotFoundError
if not data was found (Will be returned as is and not converted to match access_type).
if not data was found (Will be returned as is and not converted to match access_type).
:returns : The fetched data.
:returns: The fetched data.
"""
raise NotImplementedError

Expand Down Expand Up @@ -1008,9 +1008,9 @@ async def get_forecast(
:param access_type: How the data is to be retrieved (See AccessType for details)
:param cache: Whether to use cache for this read.
:param default: Default value that will be returned instead of raising FileNotFoundError
if not data was found (Will be returned as is and not converted to match access_type).
if not data was found (Will be returned as is and not converted to match access_type).
:returns : The fetched data.
:returns: The fetched data.
"""
raise NotImplementedError

Expand Down Expand Up @@ -1066,9 +1066,9 @@ async def get_gridded_map(
:param access_type: How the data is to be retrieved (See AccessType for details)
:param cache: Whether to use cache for this read.
:param default: Default value that will be returned instead of raising FileNotFoundError
if not data was found (Will be returned as is and not converted to match access_type).
if not data was found (Will be returned as is and not converted to match access_type).
:returns : The fetched data.
:returns: The fetched data.
"""
raise NotImplementedError

Expand Down Expand Up @@ -1118,9 +1118,9 @@ async def get_report(
:param access_type: How the data is to be retrieved (See AccessType for details)
:param cache: Whether to use cache for this read.
:param default: Default value that will be returned instead of raising FileNotFoundError
if not data was found (Will be returned as is and not converted to match access_type).
if not data was found (Will be returned as is and not converted to match access_type).
:returns : The fetched data.
:returns: The fetched data.
"""
raise NotImplementedError

Expand Down Expand Up @@ -1153,8 +1153,8 @@ async def get_by_uri(
:param access_type : See AccessType.
:param cache : Whether to use the cache.
:param default : If provided, this value will be returned instead of raising
a FileNotFoundError if not file exists. The provided object will be returned
as is, and will not be converted to match access_type.
a FileNotFoundError if not file exists. The provided object will be returned
as is, and will not be converted to match access_type.
Note:
-----
Expand Down Expand Up @@ -1202,7 +1202,8 @@ def _normalize_access_type(
:param default: The type to return if access_type is None. Defaults to AccessType.OBJ
:raises ValueError: If str access_type can't be converted to AccessType.
:raises ValueError: If access_type is not str or AccessType
:return: The normalized AccessType.
:returns: The normalized AccessType.
"""
if isinstance(access_type, AccessType):
return access_type
Expand All @@ -1223,9 +1224,9 @@ def _normalize_access_type(
async def list_all(self, access_type: str | AccessType = AccessType.URI):
"""Returns a list of identifiers for each object stored in the database
:param access_type : What to return (This is implementation specific, but
:param access_type: What to return (This is implementation specific, but
in general each implementation should support URI, some may support FILE_PATH).
:raises : UnsupportedOperation
:raises UnsupportedOperation:
For non-supported acces types.
"""
raise NotImplementedError
Expand All @@ -1242,11 +1243,11 @@ async def get_report_image(
"""
Getter for static images that are referenced from the report json files.
:param project : Project ID.
:param experiment : Experiment ID.
:param access_type : One of AccessType.BLOB, AccessType.FILE_PATH
:param project: Project ID.
:param experiment: Experiment ID.
:param access_type: One of AccessType.BLOB, AccessType.FILE_PATH
:return Either a string (If file path requested) or a bytes object with the
:returns: Either a string (If file path requested) or a bytes object with the
image data
"""
raise NotImplementedError
Expand All @@ -1257,11 +1258,11 @@ async def put_report_image(self, obj, project: str, experiment: str, path: str):
"""
Putter for static images that are referenced from the report json files.
:param obj : A bytes object representing the image data to be written.
:param project : Project ID.
:param experiment : Experiment ID.
:param obj: A bytes object representing the image data to be written.
:param project: Project ID.
:param experiment: Experiment ID.
:return Either a string (If file path requested) or a bytes object with the
:returns: Either a string (If file path requested) or a bytes object with the
image data
"""
raise NotImplementedError
Expand All @@ -1279,11 +1280,11 @@ async def get_map_overlay(
):
"""Getter for map overlay images.
:param project : Project ID.
:param experiment : Experiment ID.
:param source : Data source. Can be either an observation network or a model ID.
:param variable : Variable name.
:param date : Date.
:param project: Project ID.
:param experiment: Experiment ID.
:param source: Data source. Can be either an observation network or a model ID.
:param variable: Variable name.
:param date: Date.
"""
raise NotImplementedError

Expand All @@ -1300,11 +1301,11 @@ async def put_map_overlay(
):
"""Putter for map overlay images.
:param obj : The object to be stored.
:param project : Project ID.
:param experiment : Experiment ID.
:param source : Data source. Can be either an observation network or a model ID.
:param variable : Variable name.
:param date : Date.
:param obj: The object to be stored.
:param project: Project ID.
:param experiment: Experiment ID.
:param source: Data source. Can be either an observation network or a model ID.
:param variable: Variable name.
:param date: Date.
"""
raise NotImplementedError

0 comments on commit bffd1ca

Please sign in to comment.