Codespell

Author: avalentino

.github/workflows/lint.yml

@@ -38,6 +38,11 @@ jobs:
           python -m flake8 --version
           python -m flake8 --count --show-source --statistics src/${PACKAGE} tests
 
+      - name: Lint (pydocstyle)
+        run: |
+          python -m pydocstyle --version
+          python -m pydocstyle --count src/${PACKAGE}
+
       # - name: Lint (isort)
       #   run: |
       #     python -m isort --version
@@ -59,7 +64,7 @@ jobs:
           ruff --version
           ruff check src/${PACKAGE} tests
 
-      - name: Lint (pydocstyle)
+      - name: Lint (codespell)
         run: |
-          python -m pydocstyle --version
-          python -m pydocstyle --count src/${PACKAGE}
+          codespell --version
+          codespell --count src/${PACKAGE} tests

Makefile

@@ -84,7 +84,7 @@ lint:
 	$(PYTHON) -m black --check src/$(TARGET) tests
 	# $(PYTHON) -m mypy --check-untyped-defs --ignore-missing-imports src/$(TARGET)
 	ruff check src/$(TARGET) tests
-	# codespell
+	codespell
 
 docs:
 	mkdir -p docs/_static

docs/examples/write_ndvi.py

@@ -88,7 +88,7 @@ def main(*argv):
         with open(argv[2], "wb") as out_stream:
             # Loop over all pixel and calculate the NDVI.
             #
-            # @NOTE: looping over data matrices is not the best soluton.
+            # @NOTE: looping over data matrices is not the best solution.
             #        It is done here just for demostrative purposes
             for j in range(height):
                 for i in range(width):

docs/gdal_export_example.rst

@@ -203,7 +203,7 @@ function:
 .. index:: MPH, SPH
 
 The  :func:`epr2gdal` function also stores the contents of the *MPH* and the
-*SPH* records as GDAL_ dataset matadata in custom domains:
+*SPH* records as GDAL_ dataset metadata in custom domains:
 
 .. raw:: latex
 

docs/reference.rst

@@ -193,10 +193,10 @@ Product
             for example ``flags.LAND OR flags.CLOUD`` or
             ``NOT flags.WATER AND flags.TURBID_S``
       :param xoffset:
-            across-track co-ordinate in pixel co-ordinates (zero-based)
+            across-track coordinate in pixel coordinates (zero-based)
             of the upper right corner of the source-region
       :param yoffset:
-            along-track co-ordinate in pixel co-ordinates (zero-based)
+            along-track coordinate in pixel coordinates (zero-based)
             of the upper right corner of the source-region
       :param raster:
             the raster for the bit-mask. The data type of the raster
@@ -994,17 +994,17 @@ Band
 
       The source-region is a defined part of the whole ENVISAT
       :class:`Product` image, which shall be read into a :class:`Raster`.
-      In this routine the co-ordinates are specified, where the
+      In this routine the coordinates are specified, where the
       source-region to be read starts.
       The dimension of the region and the sub-sampling are attributes
       of the :class:`Raster` into which the data are read.
 
       :param xoffset:
-            across-track source co-ordinate in pixel co-ordinates
+            across-track source coordinate in pixel coordinates
             (zero-based) of the upper right corner of the source-region.
             Default 0.
       :param yoffset:
-            along-track source co-ordinate in pixel co-ordinates
+            along-track source coordinate in pixel coordinates
             (zero-based) of the upper right corner of the source-region.
             Default 0.
       :param raster:
@@ -1034,7 +1034,7 @@ Band
 
       The source-region is a defined part of the whole ENVISAT
       :class:`Product` image, which shall be read into a :class:`Raster`.
-      In this routine the co-ordinates are specified, where the
+      In this routine the coordinates are specified, where the
       source-region to be read starts.
       The dimension of the region and the sub-sampling are attributes
       of the :class:`Raster` into which the data are read.
@@ -1048,11 +1048,11 @@ Band
             into the :class:`Raster`, If not provided reads as much as
             possible
       :param xoffset:
-            across-track source co-ordinate in pixel co-ordinates
+            across-track source coordinate in pixel coordinates
             (zero-based) of the upper right corner of the source-region.
             Default 0.
       :param yoffset:
-            along-track source co-ordinate in pixel co-ordinates
+            along-track source coordinate in pixel coordinates
             (zero-based) of the upper right corner of the source-region.
             Default 0.
       :param xstep:
@@ -1161,7 +1161,7 @@ Raster
       :param y:
             the (zero-based) Y coordinate of the pixel
       :returns:
-            the typed value at the given co-ordinate
+            the typed value at the given coordinate
 
 
    .. method:: get_elem_size()

pyproject.toml

@@ -74,12 +74,12 @@ docs = [
     "sphinx",
     "sphinx_rtd_theme",
     "sphinxcontrib-spelling",
-    "packaginhg",
+    "packaging",
     "ipython",
 ]
 test = ["pytest", "packaging"]
 coverage = ["pytest-cov", "coverage[toml]", {include-group = "test"}]
-lint = ["flake8", "pydocstyle", "isort", "black", "ruff"]
+lint = ["flake8", "pydocstyle", "isort", "black", "ruff", "codespell"]
 dev = [
     "python-build",
     "twine",
@@ -164,10 +164,11 @@ match='(?!(test_|conf)).*\.py'
 
 
 [tool.codespell]
-skip = "*.pdf,*.ipynb,docs/spelling_wordlist.txt"
+skip = "*.pdf,*.ipynb,./docs/spelling_wordlist.txt,*.N1,extern"
 count = true
 quiet-level = 3
-# ignore-words-list = "nd"
+# ignore-words-list = ""
+ignore-words="docs/spelling_wordlist.txt"
 
 
 # [tool.mypy]

src/epr/epr.pyx

@@ -295,7 +295,7 @@ cdef class _CLib:
             msg = <char*>epr_get_last_err_message()
             epr_clear_err()
             raise ImportError(
-                f"unable to inizialize EPR API library: "
+                f"unable to initialize EPR API library: "
                 f"{_to_str(msg, 'ascii')}"
             )
 
@@ -531,7 +531,7 @@ cdef class Field(EprObject):
             offset += info.tot_size
 
         if not found:
-            raise EPRError("inable to compute field offset")
+            raise EPRError("unable to compute field offset")
         elif absolute:
             offset += self._parent._get_offset(absolute)
 
@@ -688,7 +688,7 @@ cdef class Field(EprObject):
             the field
         """
         cdef void* buf = NULL
-        cdef int nd = 1
+        cdef int ndim = 1
         cdef np.npy_intp shape[1]
         cdef np.ndarray out
         cdef EPR_Time* t = NULL
@@ -759,7 +759,7 @@ cdef class Field(EprObject):
         elif etype == e_tid_string:
             if shape[0] != 1:
                 raise ValueError(f"unexpected number of elements: {shape[0]}")
-            nd = 0
+            ndim = 0
             dtype = np.NPY_STRING
             buf = <char*>epr_get_field_elem_as_str(self._ptr)
             if buf is NULL:
@@ -771,7 +771,7 @@ cdef class Field(EprObject):
         else:
             raise ValueError("invalid field type")
 
-        out = np.PyArray_SimpleNewFromData(nd, shape, dtype, <void*>buf)
+        out = np.PyArray_SimpleNewFromData(ndim, shape, dtype, <void*>buf)
         # np.PyArray_CLEARFLAG(out, NPY_ARRAY_WRITEABLE)  # new in numpy 1.7
         # Make the ndarray keep a reference to this object
         np.set_array_base(out, self)
@@ -1047,13 +1047,13 @@ cdef class Record(EprObject):
             # elif isinstance(self._parent, Product):
             (<Product>self._parent)._check_write_mode()
 
-    cdef inline uint _get_offset(self, bint absolure=0):
+    cdef inline uint _get_offset(self, bint absolute=0):
         cdef EPR_RecordInfo* info = <EPR_RecordInfo*>self._ptr.info
         cdef uint offset = self._index * info.tot_size
 
         # assert self._index is not None
 
-        if absolure:
+        if absolute:
             offset += (<Dataset>self._parent)._get_offset()
 
         return offset
@@ -1363,7 +1363,7 @@ cdef class Raster(EprObject):
         :param y:
             the (zero-based) Y coordinate of the pixel
         :returns:
-            the typed value at the given co-ordinate
+            the typed value at the given coordinate
         """
         if (x < 0 or <uint>x >= self._ptr.raster_width or
                 y < 0 or <uint>y >= self._ptr.raster_height):
@@ -1808,15 +1808,15 @@ cdef class Band(EprObject):
             src_width = scene_width
         elif src_width > scene_width:
             raise ValueError(
-                f"requeted raster width ({src_width}) is too large for the "
+                f"requested raster width ({src_width}) is too large for the "
                 f"Band (scene_width={scene_width})"
             )
 
         if src_height == 0:
             src_height = scene_height
         elif src_height > scene_height:
             raise ValueError(
-                f"requeted raster height ({src_height}) is too large for the "
+                f"requested raster height ({src_height}) is too large for the "
                 f"Band (scene_height={scene_height})"
             )
 
@@ -1852,16 +1852,16 @@ cdef class Band(EprObject):
 
         The source-region is a defined part of the whole ENVISAT
         product image, which shall be read into a raster.
-        In this routine the co-ordinates are specified, where the
+        In this routine the coordinates are specified, where the
         source-region to be read starts.
         The dimension of the region and the sub-sampling are attributes
         of the raster into which the data are read.
 
         :param xoffset:
-            across-track source co-ordinate in pixel co-ordinates
+            across-track source coordinate in pixel coordinates
             (zero-based) of the upper right corner of the source-region
         :param yoffset:
-            along-track source co-ordinate in pixel co-ordinates
+            along-track source coordinate in pixel coordinates
             (zero-based) of the upper right corner of the source-region
         :param raster:
             :class:`Raster` instance set with appropriate parameters to
@@ -1921,7 +1921,7 @@ cdef class Band(EprObject):
 
         The source-region is a defined part of the whole ENVISAT
         product image, which shall be read into a raster.
-        In this routine the co-ordinates are specified, where the
+        In this routine the coordinates are specified, where the
         source-region to be read starts.
         The dimension of the region and the sub-sampling are attributes
         of the raster into which the data are read.
@@ -1933,10 +1933,10 @@ cdef class Band(EprObject):
             the height (along track dimension) of the source to be read
             into the raster. If not provided reads as much as possible
         :param xoffset:
-            across-track source co-ordinate in pixel co-ordinates
+            across-track source coordinate in pixel coordinates
             (zero-based) of the upper right corner of the source-region
         :param yoffset:
-            along-track source co-ordinate in pixel co-ordinates
+            along-track source coordinate in pixel coordinates
             (zero-based) of the upper right corner of the source-region
         :param xstep:
             the sub-sampling step across track of the source when
@@ -2571,10 +2571,10 @@ cdef class Product(EprObject):
             ``NOT flags.WATER AND flags.TURBID_S``
 
        :param xoffset:
-            across-track co-ordinate in pixel co-ordinates (zero-based)
+            across-track coordinate in pixel coordinates (zero-based)
             of the upper right corner of the source-region
        :param yoffset:
-            along-track co-ordinate in pixel co-ordinates (zero-based)
+            along-track coordinate in pixel coordinates (zero-based)
             of the upper right corner of the source-region
        :param raster:
             the raster for the bit-mask. The data type of the raster