Skip to content

Commit

Permalink
Remove superfluous ellipses
Browse files Browse the repository at this point in the history
  • Loading branch information
glatterf42 committed Dec 20, 2024
1 parent 0975ce3 commit 64d7787
Show file tree
Hide file tree
Showing 17 changed files with 0 additions and 91 deletions.
4 changes: 0 additions & 4 deletions ixmp4/data/abstract/docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ def get(self, dimension_id: int) -> Docs:
:class:`ixmp4.data.abstract.Docs`
The object's documentation.
"""
...

def set(self, dimension_id: int, description: str) -> Docs:
"""Sets the documentation for an object of any dimension.
Expand All @@ -59,7 +58,6 @@ def set(self, dimension_id: int, description: str) -> Docs:
:class:`ixmp4.data.abstract.Docs`
The object's documentation.
"""
...

def delete(self, dimension_id: int) -> None:
"""Deletes a dimension object's documentation.
Expand All @@ -77,7 +75,6 @@ def delete(self, dimension_id: int) -> None:
:class:`ixmp4.data.abstract.Docs.NotFound`:
If the documentation for the object with `dimension_id` does not exist.
"""
...

def list(self, *, dimension_id: int | None = None) -> list[Docs]:
"""Lists documentations.
Expand All @@ -92,4 +89,3 @@ def list(self, *, dimension_id: int | None = None) -> list[Docs]:
-------
Iterable[:class:`ixmp4.data.abstract.Docs`] : List of documentations.
"""
...
4 changes: 0 additions & 4 deletions ixmp4/data/abstract/iamc/datapoint.py
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,6 @@ def list(
Iterable[:class:`ixmp4.data.abstract.iamc.datapoint.DataPoint`]:
List of data points.
"""
...

def tabulate(
self,
Expand Down Expand Up @@ -142,7 +141,6 @@ def tabulate(
if it contains data points of type `DATETIME`
- ... misc parameter columns if `join_parameters` is set to `True`
"""
...

def bulk_upsert(self, df: pd.DataFrame) -> None:
"""Looks which data points in the supplied data frame already exists,
Expand All @@ -162,7 +160,6 @@ def bulk_upsert(self, df: pd.DataFrame) -> None:
- step_datetime
if it contains data points of type `DATETIME`
"""
...

def bulk_delete(self, df: pd.DataFrame) -> None:
"""Deletes data points which match criteria in the supplied data frame.
Expand All @@ -180,4 +177,3 @@ def bulk_delete(self, df: pd.DataFrame) -> None:
- step_datetime
if it contains data points of type `DATETIME`
"""
...
6 changes: 0 additions & 6 deletions ixmp4/data/abstract/iamc/timeseries.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,6 @@ def create(self, **kwargs: Unpack["CreateKwargs"]) -> ModelType:
:class:`ixmp4.data.abstract.iamc.timeseries.TimeSeries`:
The retrieved time series.
"""
...

# NOTE this seems unused, so I'm guessing at the parameters type
def get(self, run_id: int, parameters: Mapping[str, Any]) -> ModelType:
Expand All @@ -93,7 +92,6 @@ def get(self, run_id: int, parameters: Mapping[str, Any]) -> ModelType:
:class:`ixmp4.data.base.TimeSeries`:
The retrieved time series.
"""
...

def get_by_id(self, id: int) -> ModelType:
"""Retrieves a time series by it's id.
Expand All @@ -113,7 +111,6 @@ def get_by_id(self, id: int) -> ModelType:
:class:`ixmp4.data.base.TimeSeries`:
The retrieved time series.
"""
...

def get_or_create(self, run_id: int, parameters: Mapping[str, Any]) -> ModelType:
"""Tries to retrieve a time series and creates it if it was not found.
Expand Down Expand Up @@ -149,7 +146,6 @@ def list(self, **kwargs: Unpack[EnumerateKwargs]) -> list[ModelType]:
Iterable[:class:`ixmp4.data.base.TimeSeries`]:
List of time series.
"""
...

def tabulate(
self, *, join_parameters: bool | None = False, **kwargs: Unpack[EnumerateKwargs]
Expand All @@ -175,7 +171,6 @@ def tabulate(
Or:
- ... parameter value columns
"""
...

def bulk_upsert(
self, df: pd.DataFrame, create_related: bool | None = False
Expand All @@ -200,4 +195,3 @@ def bulk_upsert(
create_related : bool
Creates related database entries with value data supplied in `df`.
"""
...
4 changes: 0 additions & 4 deletions ixmp4/data/abstract/iamc/variable.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,6 @@ def create(self, name: str) -> Variable:
:class:`ixmp4.data.abstract.Variable`:
The created variable.
"""
...

def get(self, name: str) -> Variable:
"""Retrieves a variable.
Expand All @@ -85,7 +84,6 @@ def get(self, name: str) -> Variable:
:class:`ixmp4.data.abstract.Variable`:
The retrieved variable.
"""
...

def list(self, **kwargs: Unpack[EnumerateKwargs]) -> list[Variable]:
r"""Lists variables by specified criteria.
Expand All @@ -101,7 +99,6 @@ def list(self, **kwargs: Unpack[EnumerateKwargs]) -> list[Variable]:
Iterable[:class:`ixmp4.data.abstract.Variable`]:
List of variables.
"""
...

def tabulate(self, **kwargs: Unpack[EnumerateKwargs]) -> pd.DataFrame:
r"""Tabulate variables by specified criteria.
Expand All @@ -119,4 +116,3 @@ def tabulate(self, **kwargs: Unpack[EnumerateKwargs]) -> pd.DataFrame:
- id
- name
"""
...
7 changes: 0 additions & 7 deletions ixmp4/data/abstract/meta.py
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,6 @@ def create(self, run__id: int, key: str, value: MetaValue) -> RunMetaEntry:
:class:`ixmp4.data.base.RunMetaEntry`:
The created entry.
"""
...

def get(self, run__id: int, key: str) -> RunMetaEntry:
"""Retrieves a run's meta indicator entry.
Expand All @@ -140,7 +139,6 @@ def get(self, run__id: int, key: str) -> RunMetaEntry:
:class:`ixmp4.data.base.Run`:
The retrieved entry.
"""
...

def delete(self, id: int) -> None:
"""Deletes a run's meta indicator entry.
Expand All @@ -157,7 +155,6 @@ def delete(self, id: int) -> None:
:class:`ixmp4.data.abstract.RunMetaEntry.NotFound`:
If the entry with `id` does not exist.
"""
...

def list(
self, join_run_index: bool = False, **kwargs: Unpack[EnumerateKwargs]
Expand All @@ -177,7 +174,6 @@ def list(
Iterable[:class:`ixmp4.data.abstract.RunMetaEntry`]:
List of run meta indicator entries.
"""
...

def tabulate(
self, join_run_index: bool = False, **kwargs: Unpack[EnumerateKwargs]
Expand All @@ -202,7 +198,6 @@ def tabulate(
- type
- value
"""
...

def bulk_upsert(self, df: pd.DataFrame) -> None:
"""Upserts a dataframe of run meta indicator entries.
Expand All @@ -216,7 +211,6 @@ def bulk_upsert(self, df: pd.DataFrame) -> None:
- value
- type
"""
...

def bulk_delete(self, df: pd.DataFrame) -> None:
"""Deletes run meta indicator entries as specified per dataframe.
Expand All @@ -231,4 +225,3 @@ def bulk_delete(self, df: pd.DataFrame) -> None:
- key
"""
...
4 changes: 0 additions & 4 deletions ixmp4/data/abstract/model.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@ def create(self, name: str) -> Model:
:class:`ixmp4.data.abstract.Model`:
The created model.
"""
...

def get(self, name: str) -> Model:
"""Retrieves a model.
Expand All @@ -79,7 +78,6 @@ def get(self, name: str) -> Model:
:class:`ixmp4.data.abstract.Model`:
The retrieved model.
"""
...

def list(self, **kwargs: Unpack[EnumerateKwargs]) -> list[Model]:
r"""Lists models by specified criteria.
Expand All @@ -95,7 +93,6 @@ def list(self, **kwargs: Unpack[EnumerateKwargs]) -> list[Model]:
Iterable[:class:`ixmp4.data.abstract.Model`]:
List of Model.
"""
...

def tabulate(self, **kwargs: Unpack[EnumerateKwargs]) -> pd.DataFrame:
r"""Tabulate models by specified criteria.
Expand All @@ -114,7 +111,6 @@ def tabulate(self, **kwargs: Unpack[EnumerateKwargs]) -> pd.DataFrame:
- name
"""
...

def map(self, **kwargs: Unpack[EnumerateKwargs]) -> dict[int, str]:
"""Return a mapping of model-id to model-name.
Expand Down
7 changes: 0 additions & 7 deletions ixmp4/data/abstract/optimization/equation.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,6 @@ def create(
:class:`ixmp4.data.abstract.optimization.Equation`:
The created Equation.
"""
...

def get(self, run_id: int, name: str) -> Equation:
"""Retrieves an Equation.
Expand All @@ -111,7 +110,6 @@ def get(self, run_id: int, name: str) -> Equation:
:class:`ixmp4.data.abstract.optimization.Equation`:
The retrieved Equation.
"""
...

def get_by_id(self, id: int) -> Equation:
"""Retrieves an Equation by its id.
Expand All @@ -131,7 +129,6 @@ def get_by_id(self, id: int) -> Equation:
:class:`ixmp4.data.abstract.optimization.Equation`:
The retrieved Equation.
"""
...

def list(self, **kwargs: Unpack["EnumerateKwargs"]) -> Iterable[Equation]:
r"""Lists Equations by specified criteria.
Expand All @@ -147,7 +144,6 @@ def list(self, **kwargs: Unpack["EnumerateKwargs"]) -> Iterable[Equation]:
Iterable[:class:`ixmp4.data.abstract.optimization.Equation`]:
List of Equations.
"""
...

def tabulate(self, **kwargs: Unpack["EnumerateKwargs"]) -> pd.DataFrame:
r"""Tabulate Equations by specified criteria.
Expand All @@ -169,7 +165,6 @@ def tabulate(self, **kwargs: Unpack["EnumerateKwargs"]) -> pd.DataFrame:
- created_at
- created_by
"""
...

# TODO Question for Daniel: do equations need to allow adding data manually?
# TODO Once present, state how to check which IndexSets are linked and which values
Expand Down Expand Up @@ -203,7 +198,6 @@ def add_data(self, equation_id: int, data: dict[str, Any] | pd.DataFrame) -> Non
-------
None
"""
...

def remove_data(self, equation_id: int) -> None:
"""Removes data from an Equation.
Expand All @@ -217,4 +211,3 @@ def remove_data(self, equation_id: int) -> None:
-------
None
"""
...
5 changes: 0 additions & 5 deletions ixmp4/data/abstract/optimization/indexset.py
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,6 @@ def create(self, run_id: int, name: str) -> IndexSet:
:class:`ixmp4.data.abstract.IndexSet`:
The created IndexSet.
"""
...

def get(self, run_id: int, name: str) -> IndexSet:
"""Retrieves an IndexSet.
Expand All @@ -89,7 +88,6 @@ def get(self, run_id: int, name: str) -> IndexSet:
:class:`ixmp4.data.abstract.IndexSet`:
The retrieved IndexSet.
"""
...

def list(self, **kwargs: Unpack["EnumerateKwargs"]) -> list[IndexSet]:
r"""Lists IndexSets by specified criteria.
Expand All @@ -105,7 +103,6 @@ def list(self, **kwargs: Unpack["EnumerateKwargs"]) -> list[IndexSet]:
Iterable[:class:`ixmp4.data.abstract.IndexSet`]:
List of IndexSets.
"""
...

def tabulate(self, **kwargs: Unpack["EnumerateKwargs"]) -> pd.DataFrame:
r"""Tabulate IndexSets by specified criteria.
Expand All @@ -127,7 +124,6 @@ def tabulate(self, **kwargs: Unpack["EnumerateKwargs"]) -> pd.DataFrame:
- created_at
- created_by
"""
...

def add_data(
self,
Expand All @@ -148,4 +144,3 @@ def add_data(
None:
Due to compatibility with ixmp.
"""
...
6 changes: 0 additions & 6 deletions ixmp4/data/abstract/optimization/parameter.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,6 @@ def create(
:class:`ixmp4.data.abstract.optimization.Parameter`:
The created Parameter.
"""
...

def get(self, run_id: int, name: str) -> Parameter:
"""Retrieves a Parameter.
Expand All @@ -111,7 +110,6 @@ def get(self, run_id: int, name: str) -> Parameter:
:class:`ixmp4.data.abstract.optimization.Parameter`:
The retrieved Parameter.
"""
...

def get_by_id(self, id: int) -> Parameter:
"""Retrieves a Parameter by its id.
Expand All @@ -131,7 +129,6 @@ def get_by_id(self, id: int) -> Parameter:
:class:`ixmp4.data.abstract.optimization.Parameter`:
The retrieved Parameter.
"""
...

def list(self, **kwargs: Unpack["EnumerateKwargs"]) -> Iterable[Parameter]:
r"""Lists Parameters by specified criteria.
Expand All @@ -147,7 +144,6 @@ def list(self, **kwargs: Unpack["EnumerateKwargs"]) -> Iterable[Parameter]:
Iterable[:class:`ixmp4.data.abstract.optimization.Parameter`]:
List of Parameters.
"""
...

def tabulate(self, **kwargs: Unpack["EnumerateKwargs"]) -> pd.DataFrame:
r"""Tabulate Parameters by specified criteria.
Expand All @@ -169,7 +165,6 @@ def tabulate(self, **kwargs: Unpack["EnumerateKwargs"]) -> pd.DataFrame:
- created_at
- created_by
"""
...

# TODO Once present, state how to check which IndexSets are linked and which values
# they permit
Expand Down Expand Up @@ -202,4 +197,3 @@ def add_data(self, parameter_id: int, data: dict[str, Any] | pd.DataFrame) -> No
-------
None
"""
...
6 changes: 0 additions & 6 deletions ixmp4/data/abstract/optimization/scalar.py
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,6 @@ def create(self, run_id: int, name: str, value: float, unit_name: str) -> Scalar
:class:`ixmp4.data.abstract.optimization.Scalar`:
The created Scalar.
"""
...

def update(
self, id: int, value: float | None = None, unit_id: int | None = None
Expand All @@ -102,7 +101,6 @@ def update(
:class:`ixmp4.data.abstract.optimization.Scalar`:
The updated Scalar.
"""
...

def get(self, run_id: int, name: str) -> Scalar:
"""Retrieves a Scalar.
Expand All @@ -125,7 +123,6 @@ def get(self, run_id: int, name: str) -> Scalar:
:class:`ixmp4.data.abstract.optimization.Scalar`:
The retrieved Scalar.
"""
...

def get_by_id(self, id: int) -> Scalar:
"""Retrieves a Scalar by its id.
Expand All @@ -145,7 +142,6 @@ def get_by_id(self, id: int) -> Scalar:
:class:`ixmp4.data.abstract.optimization.Scalar`:
The retrieved Scalar.
"""
...

def list(self, **kwargs: Unpack["EnumerateKwargs"]) -> Iterable[Scalar]:
r"""Lists Scalars by specified criteria.
Expand All @@ -161,7 +157,6 @@ def list(self, **kwargs: Unpack["EnumerateKwargs"]) -> Iterable[Scalar]:
Iterable[:class:`ixmp4.data.abstract.optimization.Scalar`]:
List of Scalars.
"""
...

def tabulate(self, **kwargs: Unpack["EnumerateKwargs"]) -> pd.DataFrame:
r"""Tabulate Scalars by specified criteria.
Expand All @@ -184,4 +179,3 @@ def tabulate(self, **kwargs: Unpack["EnumerateKwargs"]) -> pd.DataFrame:
- created_at
- created_by
"""
...
Loading

0 comments on commit 64d7787

Please sign in to comment.