Merge pull request #580 from Sherwin-14/linting

Added linting of docstrings

earthaccess/__init__.py

@@ -61,8 +61,7 @@
 
 
 def __getattr__(name): # type: ignore
- """
- Module-level getattr to handle automatic authentication when accessing
+ """Module-level getattr to handle automatic authentication when accessing
  `earthaccess.__auth__` and `earthaccess.__store__`.
 
  Other unhandled attributes raise as `AttributeError` as expected.

earthaccess/api.py

@@ -268,7 +268,7 @@ def collection_query() -> CollectionQuery:
 
 
 def granule_query() -> GranuleQuery:
- """Returns a query builder instance for data granules
+ """Returns a query builder instance for data granules.
 
  Returns:
  a query builder instance for data granules.

earthaccess/auth.py

@@ -25,8 +25,7 @@
 
 
 class SessionWithHeaderRedirection(requests.Session):
- """
- Requests removes auth headers if the redirect happens outside the
+ """Requests removes auth headers if the redirect happens outside the
  original req domain.
  """
 

earthaccess/formatters.py

@@ -7,7 +7,7 @@
 
 
 def _load_static_files() -> List[str]:
- """Load styles"""
+ """Load styles."""
  return [
  importlib_resources.files("earthaccess.css").joinpath(fname).read_text("utf8")
  for fname in STATIC_FILES

earthaccess/results.py

@@ -94,9 +94,10 @@ def summary(self) -> Dict[str, Any]:
  return summary_dict
 
  def get_umm(self, umm_field: str) -> Union[str, Dict[str, Any]]:
- """
+ """Placeholder.
+
  Parameters:
- umm_field: Valid UMM item, i.e. `TemporalExtent`
+ umm_field: Valid UMM item, i.e. `TemporalExtent`.
 
  Returns:
  The value of a given field inside the UMM (Unified Metadata Model).
@@ -106,15 +107,16 @@ def get_umm(self, umm_field: str) -> Union[str, Dict[str, Any]]:
  return ""
 
  def concept_id(self) -> str:
- """
+ """Placeholder.
+
  Returns:
- A collection's `concept_id`.
- This id is the most relevant search field on granule queries.
+ A collection's `concept_id`.This id is the most relevant search field on granule queries.
  """
  return self["meta"]["concept-id"]
 
  def data_type(self) -> str:
- """
+ """Placeholder.
+
  Returns:
  The collection data type, i.e. HDF5, CSV etc., if available.
  """
@@ -127,7 +129,8 @@ def data_type(self) -> str:
  return ""
 
  def version(self) -> str:
- """
+ """Placeholder.
+
  Returns:
  The collection's version.
  """
@@ -136,16 +139,18 @@ def version(self) -> str:
  return ""
 
  def abstract(self) -> str:
- """
+ """Placeholder.
+
  Returns:
- The abstract of a collection
+ The abstract of a collection.
  """
  if "Abstract" in self["umm"]:
  return self["umm"]["Abstract"]
  return ""
 
  def landing_page(self) -> str:
- """
+ """Placeholder.
+
  Returns:
  The first landing page for the collection (can be many), if available.
  """
@@ -155,18 +160,19 @@ def landing_page(self) -> str:
  return ""
 
  def get_data(self) -> List[str]:
- """
+ """Placeholder.
+
  Returns:
  The GET DATA links (usually a landing page link, a DAAC portal, or an FTP location).
  """
  links = self._filter_related_links("GET DATA")
  return links
 
  def s3_bucket(self) -> Dict[str, Any]:
- """
+ """Placeholder.
+
  Returns:
- The S3 bucket information if the collection has it.
- (**cloud hosted collections only**)
+ The S3 bucket information if the collection has it (**cloud hosted collections only**).
  """
  if "DirectDistributionInformation" in self["umm"]:
  return self["umm"]["DirectDistributionInformation"]
@@ -214,7 +220,8 @@ def __init__(
  self.render_dict = self._filter_fields_(fields)
 
  def __repr__(self) -> str:
- """
+ """Placeholder.
+
  Returns:
  A basic representation of a data granule.
  """
@@ -229,7 +236,8 @@ def __repr__(self) -> str:
  return rep_str
 
  def _repr_html_(self) -> str:
- """
+ """Placeholder.
+
  Returns:
  A rich representation for a data granule if we are in a Jupyter notebook.
  """
@@ -243,7 +251,8 @@ def get_s3_credentials_endpoint(self) -> Union[str, None]:
  return None
 
  def size(self) -> float:
- """
+ """Placeholder.
+
  Returns:
  The total size for the granule in MB.
  """
@@ -284,7 +293,9 @@ def _derive_s3_link(self, links: List[str]) -> List[str]:
  def data_links(
  self, access: Optional[str] = None, in_region: bool = False
  ) -> List[str]:
- """Returns the data links from a granule.
+ """Placeholder.
+
+ Returns the data links from a granule.
 
  Parameters:
  access: direct or external.
@@ -325,7 +336,8 @@ def data_links(
  return https_links
 
  def dataviz_links(self) -> List[str]:
- """
+ """Placeholder.
+
  Returns:
  The data visualization links, usually the browse images.
  """

earthaccess/search.py

@@ -33,8 +33,7 @@ def get_results(
  query: Union[CollectionQuery, GranuleQuery],
  limit: int = 2000,
 ) -> List[Any]:
- """
- Get all results up to some limit, even if spanning multiple pages.
+ """Get all results up to some limit, even if spanning multiple pages.
 
  ???+ Tip
  The default page size is 2000, if the supplied value is greater then the
@@ -50,7 +49,6 @@ def get_results(
  Raises:
  RuntimeError: The CMR query failed.
  """
-
  page_size = min(limit, 2000)
  url = query._build_url()
 
@@ -79,7 +77,8 @@ def get_results(
 
 
 class DataCollections(CollectionQuery):
- """
+ """Placeholder.
+
  ???+ Info
  The DataCollection class queries against
  https://cmr.earthdata.nasa.gov/search/collections.umm_json,
@@ -156,7 +155,6 @@ def get(self, limit: int = 2000) -> List[DataCollection]:
  Raises:
  RuntimeError: The CMR query failed.
  """
-
  return [
  DataCollection(collection, self._fields)
  for collection in get_results(self.session, self, limit)
@@ -442,7 +440,6 @@ def temporal(
  object; or `date_from` and `date_to` are both datetime objects (or
  parsable as such) and `date_from` is after `date_to`.
  """
-
  return super().temporal(date_from, date_to, exclude_boundary)
 
 
@@ -481,7 +478,6 @@ def hits(self) -> int:
  Raises:
  RuntimeError: The CMR query failed.
  """
-
  url = self._build_url()
 
  response = self.session.get(url, headers=self.headers, params={"page_size": 0})
@@ -842,7 +838,6 @@ def temporal(
  object; or `date_from` and `date_to` are both datetime objects (or
  parsable as such) and `date_from` is after `date_to`.
  """
-
  return super().temporal(date_from, date_to, exclude_boundary)
 
  @override
@@ -969,7 +964,6 @@ def doi(self, doi: str) -> Self:
  Raises:
  RuntimeError: The CMR query to get the collection for the DOI fails.
  """
-
  # TODO consider deferring this query until the search is executed
  collection = DataCollections().doi(doi).get()
 

pyproject.toml

@@ -142,7 +142,12 @@ line-length = 88
 src = ["earthaccess", "stubs", "tests"]
 
 [tool.ruff.lint]
-extend-select = ["I", "T20"]
+extend-select = ["I", "T20", "D"]
+ignore = ["D1", "D205", "D401", "D417"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
 
 [tool.ruff.lint.isort]
 combine-as-imports = true

tests/integration/test_cloud_download.py

@@ -72,9 +72,8 @@
 
 
 def get_sample_granules(granules, sample_size, max_granule_size):
- """
- returns a list with sample granules and their size in MB if
- the total size is less than the max_granule_size
+ """Returns a list with sample granules and their size in MB if
+ the total size is less than the max_granule_size.
  """
  files_to_download = []
  total_size = 0
@@ -98,9 +97,7 @@ def get_sample_granules(granules, sample_size, max_granule_size):
 
 @pytest.mark.parametrize("daac", daac_list)
 def test_earthaccess_can_download_cloud_collection_granules(daac):
- """
- Tests that we can download cloud collections using HTTPS links
- """
+ """Tests that we can download cloud collections using HTTPS links."""
  daac_shortname = daac["short_name"]
  collections_count = daac["collections_count"]
  collections_sample_size = daac["collections_sample_size"]

tests/integration/test_cloud_open.py

@@ -71,9 +71,8 @@
 
 
 def get_sample_granules(granules, sample_size, max_granule_size):
- """
- returns a list with sample granules and their size in MB if
- the total size is less than the max_granule_size
+ """Returns a list with sample granules and their size in MB if
+ the total size is less than the max_granule_size.
  """
  files_to_download = []
  total_size = 0
@@ -104,9 +103,7 @@ def supported_collection(data_links):
 
 @pytest.mark.parametrize("daac", daacs_list)
 def test_earthaccess_can_open_onprem_collection_granules(daac):
- """
- Tests that we can download cloud collections using HTTPS links
- """
+ """Tests that we can download cloud collections using HTTPS links."""
  daac_shortname = daac["short_name"]
  collections_count = daac["collections_count"]
  collections_sample_size = daac["collections_sample_size"]

tests/integration/test_onprem_download.py

@@ -64,9 +64,8 @@
 
 
 def get_sample_granules(granules, sample_size, max_granule_size):
- """
- returns a list with sample granules and their size in MB if
- the total size is less than the max_granule_size
+ """Returns a list with sample granules and their size in MB if
+ the total size is less than the max_granule_size.
  """
  files_to_download = []
  total_size = 0
@@ -97,9 +96,7 @@ def supported_collection(data_links):
 
 @pytest.mark.parametrize("daac", daacs_list)
 def test_earthaccess_can_download_onprem_collection_granules(daac):
- """
- Tests that we can download cloud collections using HTTPS links
- """
+ """Tests that we can download cloud collections using HTTPS links."""
  daac_shortname = daac["short_name"]
  collections_count = daac["collections_count"]
  collections_sample_size = daac["collections_sample_size"]

tests/integration/test_onprem_open.py

@@ -63,9 +63,8 @@
 
 
 def get_sample_granules(granules, sample_size, max_granule_size):
- """
- returns a list with sample granules and their size in MB if
- the total size is less than the max_granule_size
+ """Returns a list with sample granules and their size in MB if
+ the total size is less than the max_granule_size.
  """
  files_to_download = []
  total_size = 0
@@ -96,9 +95,7 @@ def supported_collection(data_links):
 
 @pytest.mark.parametrize("daac", daacs_list)
 def test_earthaccess_can_open_onprem_collection_granules(daac):
- """
- Tests that we can download cloud collections using HTTPS links
- """
+ """Tests that we can download cloud collections using HTTPS links."""
  daac_shortname = daac["short_name"]
  collections_count = daac["collections_count"]
  collections_sample_size = daac["collections_sample_size"]