pycoast 1.7.0__tar.gz → 1.7.1__tar.gz

{pycoast-1.7.0 → pycoast-1.7.1}/MANIFEST.in

@@ -3,7 +3,6 @@ recursive-include docs/source *
 include pycoast/tests/*.png
 recursive-include pycoast/tests/ *
 include LICENSE.txt
-include MANIFEST.in
 
 include versioneer.py
 include pycoast/version.py

{pycoast-1.7.0/pycoast.egg-info → pycoast-1.7.1}/PKG-INFO

@@ -1,12 +1,9 @@
 Metadata-Version: 2.1
 Name: pycoast
-Version: 1.7.0
+Version: 1.7.1
 Summary: Writing of coastlines, borders and rivers to images in Python
-Home-page: UNKNOWN
 Author: Esben S. Nielsen
 Author-email: esn@dmi.dk
-License: UNKNOWN
-Platform: UNKNOWN
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Programming Language :: Python
@@ -14,10 +11,27 @@ Classifier: Operating System :: OS Independent
 Classifier: Intended Audience :: Science/Research
 Classifier: Topic :: Scientific/Engineering
 Requires-Python: >3.9
-Provides-Extra: docs
-Provides-Extra: tests
 License-File: LICENSE.txt
 License-File: AUTHORS.md
+Requires-Dist: aggdraw
+Requires-Dist: pyshp
+Requires-Dist: numpy
+Requires-Dist: pyproj
+Requires-Dist: pillow
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: pyresample; extra == "docs"
+Requires-Dist: pytest; extra == "docs"
+Requires-Dist: pytest-lazy-fixtures; extra == "docs"
+Requires-Dist: sphinx_rtd_theme; extra == "docs"
+Requires-Dist: sphinxcontrib-apidoc; extra == "docs"
+Provides-Extra: tests
+Requires-Dist: pyresample; extra == "tests"
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: pytest-cov; extra == "tests"
+Requires-Dist: coverage; extra == "tests"
+Requires-Dist: coveralls; extra == "tests"
+Requires-Dist: pytest-lazy-fixtures; extra == "tests"
 
 PyCoast
 =======
@@ -65,5 +79,3 @@ Example
     >>> cw.add_rivers(img, area_def, level=5, outline='blue')
     >>> cw.add_borders(img, area_def, outline=(255, 0, 0))
     >>> img.show()
-
-

{pycoast-1.7.0 → pycoast-1.7.1}/pycoast/cw_base.py

@@ -26,6 +26,7 @@ import json
 import logging
 import math
 import os
+from pathlib import Path
 from typing import Generator
 
 import numpy as np
@@ -501,11 +502,11 @@ class ContourWriterBase(object):
         return overlays
 
     def add_overlay_from_dict(self, overlays, area_def, cache_epoch=None, background=None):
-        """Create and return a transparent image adding all the overlays contained in the `overlays` dict.
+        """Create and return a transparent image adding all the overlays contained in the ``overlays`` dict.
 
         Optionally caches overlay results for faster rendering of images with
         the same provided AreaDefinition and parameters. Cached results are
-        identified by hashing the AreaDefinition and the overlays dictionary.
+        identified by hashing the AreaDefinition and the ``overlays`` dictionary.
 
         Note that if ``background`` is provided and caching is not used, the
         result will be the final result of applying the overlays onto the
@@ -530,24 +531,33 @@ class ContourWriterBase(object):
                 provided dictionary (see below).
             background: pillow image instance
                 The image on which to write the overlays on. If it's None (default),
-                a new image is created, otherwise the provide background is
+                a new image is created, otherwise the provided background is
                 used and changed *in place*.
 
+        The keys in ``overlays`` that will be taken into account are:
+        cache, coasts, rivers, borders, shapefiles, grid, cities, points
 
-            The keys in `overlays` that will be taken into account are:
-            cache, coasts, rivers, borders, shapefiles, grid, cities, points
+        For all of them except ``cache``, the items are the same as the
+        corresponding functions in pycoast, so refer to the docstrings of
+        these functions (add_coastlines, add_rivers, add_borders,
+        add_shapefile_shapes, add_grid, add_cities, add_points).
+        For cache, two parameters are configurable:
 
-            For all of them except `cache`, the items are the same as the
-            corresponding functions in pycoast, so refer to the docstrings of
-            these functions (add_coastlines, add_rivers, add_borders,
-            add_shapefile_shapes, add_grid, add_cities, add_points).
-            For cache, two parameters are configurable:
+        - `file`:
+            specify the directory and the prefix
+            of the file to save the caches decoration to (for example
+            /var/run/black_coasts_red_borders)
+        - `regenerate`:
+            True or False (default) to force the overwriting
+            of an already cached file.
 
-            - `file`: specify the directory and the prefix
-                  of the file to save the caches decoration to (for example
-                  /var/run/black_coasts_red_borders)
-            - `regenerate`: True or False (default) to force the overwriting
-                  of an already cached file.
+        :Returns: PIL.Image.Image
+
+            Resulting overlays as an Image object. If caching was used then
+            the Image wraps an open file and should be closed by the caller.
+            If caching was not used or the cached image was recreated then
+            this is an in-memory Image object. Regardless, it can be closed
+            by calling the ``.close()`` method of the Image.
 
         """
         overlay_helper = _OverlaysFromDict(self, overlays, area_def, cache_epoch, background)
@@ -556,12 +566,22 @@ class ContourWriterBase(object):
     def add_overlay_from_config(self, config_file, area_def, background=None):
         """Create and return a transparent image adding all the overlays contained in a configuration file.
 
+        See :meth:`add_overlay_from_dict` for more information.
+
         :Parameters:
             config_file : str
                 Configuration file name
             area_def : object
                 Area Definition of the creating image
 
+        :Returns: PIL.Image.Image
+
+            Resulting overlays as an Image object. If caching was used then
+            the Image wraps an open file and should be closed by the caller.
+            If caching was not used or the cached image was recreated then
+            this is an in-memory Image object. Regardless, it can be closed
+            by calling the ``.close()`` method of the Image.
+
         """
         overlays = self._config_to_dict(config_file)
         return self.add_overlay_from_dict(overlays, area_def, os.path.getmtime(config_file), background)
@@ -705,8 +725,7 @@ class ContourWriterBase(object):
         # cities.red is a reduced version of the files avalable at http://download.geonames.org
         # Fields: 0=name (UTF-8), 1=asciiname, 2=longitude [°E], 3=latitude [°N], 4=countrycode
         cities_filename = os.path.join(db_root_path, os.path.join("CITIES", "cities.txt"))
-        cities_parser = GeoNamesCitiesParser(cities_filename)
-        for city_name, lon, lat in cities_parser.iter_cities_names_lon_lat(cities_list):
+        for city_name, lon, lat in iter_cities_names_lon_lat(cities_filename, cities_list):
             try:
                 x, y = area_def.get_array_indices_from_lonlat(lon, lat)
             except ValueError:
@@ -1132,14 +1151,12 @@ def _get_pixel_index(shape, area_extent, x_size, y_size, prj, x_offset=0, y_offs
     return index_arrays, is_reduced
 
 
-class GeoNamesCitiesParser:
-    """Helper for parsing citiesN.txt files from GeoNames.org."""
-
-    def __init__(self, cities_filename: str):
-        self._cities_file = open(cities_filename, mode="r", encoding="utf-8")
-
-    def iter_cities_names_lon_lat(self, cities_list: list[str]) -> Generator[tuple[str, float, float], None, None]:
-        for city_row in self._cities_file:
+def iter_cities_names_lon_lat(
+    cities_filename: str | Path, cities_list: list[str]
+) -> Generator[tuple[str, float, float], None, None]:
+    """Iterate over citiesN.txt files from GeoNames.org."""
+    with open(cities_filename, mode="r", encoding="utf-8") as cities_file:
+        for city_row in cities_file:
             city_info = city_row.split("\t")
             if not city_info or not (city_info[1] in cities_list or city_info[2] in cities_list):
                 continue
@@ -1441,7 +1458,7 @@ class _OverlaysFromDict:
 def _apply_cached_foreground_on_background(background, foreground):
     premult_foreground = foreground.convert("RGBa")
     if background.mode == "RGBA":
-        # Cached foreground and background are both RGBA, not extra conversions needed
+        # Cached foreground and background are both RGBA, no extra conversions needed
         background.paste(premult_foreground, mask=premult_foreground)
         return
     background_rgba = background.convert("RGBA")
@@ -1521,7 +1538,7 @@ class _GridDrawer:
         min_lons[min_lons > 180] = min_lons[min_lons > 180] - 360
 
         # Get min_lons not in maj_lons
-        min_lons = np.lib.arraysetops.setdiff1d(min_lons, maj_lons)
+        min_lons = np.setdiff1d(min_lons, maj_lons)
 
         # lats along major lon lines
         lin_lats = np.arange(
@@ -1542,7 +1559,7 @@ class _GridDrawer:
         min_lats = np.arange(round_lat_min + increase_min_lat, lat_max - shorten_max_lat, dlat)
 
         # Get min_lats not in maj_lats
-        min_lats = np.lib.arraysetops.setdiff1d(min_lats, maj_lats)
+        min_lats = np.setdiff1d(min_lats, maj_lats)
 
         # lons along major lat lines (extended slightly to avoid missing the end)
         lin_lons = np.linspace(lon_min, lon_max + Dlon / 5.0, max(self._x_size, self._y_size) // 5)

{pycoast-1.7.0 → pycoast-1.7.1}/pycoast/tests/test_pycoast.py

@@ -30,7 +30,7 @@ import shapefile
 from PIL import Image, ImageFont
 from pyproj import CRS
 from pyresample.geometry import AreaDefinition
-from pytest_lazyfixture import lazy_fixture
+from pytest_lazy_fixtures import lf as lazy_fixture
 
 LOCAL_DIR = os.path.dirname(__file__)
 
@@ -1900,6 +1900,7 @@ class TestFromConfig:
         # Create the original cache file
         img = cw.add_overlay_from_dict(overlays, area_def)
         res = np.array(img)
+        img.close()
         cache_glob = glob(os.path.join(tmpdir, "pycoast_cache_*.png"))
         assert len(cache_glob) == 1
         cache_filename = cache_glob[0]
@@ -1910,22 +1911,26 @@ class TestFromConfig:
         # Reuse the generated cache file
         img = cw.add_overlay_from_dict(overlays, area_def)
         res = np.array(img)
+        img.close()
         assert fft_metric(euro_data, res), "Writing of contours failed"
         assert os.path.isfile(cache_filename)
         assert os.path.getmtime(cache_filename) == mtime
 
         # Regenerate cache file
         current_time = time.time()
-        cw.add_overlay_from_dict(overlays, area_def, current_time)
+        fg_img = cw.add_overlay_from_dict(overlays, area_def, current_time)
+        fg_img.close()
         mtime = os.path.getmtime(cache_filename)
         assert mtime > current_time
         assert fft_metric(euro_data, res), "Writing of contours failed"
 
-        cw.add_overlay_from_dict(overlays, area_def, current_time)
+        fg_img = cw.add_overlay_from_dict(overlays, area_def, current_time)
+        fg_img.close()
         assert os.path.getmtime(cache_filename) == mtime
         assert fft_metric(euro_data, res), "Writing of contours failed"
         overlays["cache"]["regenerate"] = True
-        cw.add_overlay_from_dict(overlays, area_def)
+        fg_img = cw.add_overlay_from_dict(overlays, area_def)
+        fg_img.close()
 
         assert os.path.getmtime(cache_filename) != mtime
         assert fft_metric(euro_data, res), "Writing of contours failed"
@@ -1943,7 +1948,8 @@ class TestFromConfig:
             "lat_placement": "lr",
             "lon_placement": "b",
         }
-        cw.add_overlay_from_dict(overlays, area_def)
+        fg_img = cw.add_overlay_from_dict(overlays, area_def)
+        fg_img.close()
         os.remove(cache_filename)
 
     def test_caching_with_param_changes(self, tmpdir):
@@ -1962,7 +1968,8 @@ class TestFromConfig:
         }
 
         # Create the original cache file
-        cw.add_overlay_from_dict(overlays, area_def)
+        fg_img = cw.add_overlay_from_dict(overlays, area_def)
+        fg_img.close()
         cache_glob = glob(os.path.join(tmpdir, "pycoast_cache_*.png"))
         assert len(cache_glob) == 1
         cache_filename = cache_glob[0]
@@ -1970,7 +1977,8 @@ class TestFromConfig:
         mtime = os.path.getmtime(cache_filename)
 
         # Reuse the generated cache file
-        cw.add_overlay_from_dict(overlays, area_def)
+        fg_img = cw.add_overlay_from_dict(overlays, area_def)
+        fg_img.close()
         cache_glob = glob(os.path.join(tmpdir, "pycoast_cache_*.png"))
         assert len(cache_glob) == 1
         assert os.path.isfile(cache_filename)
@@ -1979,7 +1987,8 @@ class TestFromConfig:
         # Remove the font option, should produce the same result
         # font is not considered when caching
         del overlays["grid"]["font"]
-        cw.add_overlay_from_dict(overlays, area_def)
+        fg_img = cw.add_overlay_from_dict(overlays, area_def)
+        fg_img.close()
         cache_glob = glob(os.path.join(tmpdir, "pycoast_cache_*.png"))
         assert len(cache_glob) == 1
         assert os.path.isfile(cache_filename)
@@ -1990,7 +1999,8 @@ class TestFromConfig:
             "cache": {"file": os.path.join(tmpdir, "pycoast_cache")},
             "grid": {"width": 2.0},
         }
-        cw.add_overlay_from_dict(overlays, area_def)
+        fg_img = cw.add_overlay_from_dict(overlays, area_def)
+        fg_img.close()
         cache_glob = glob(os.path.join(tmpdir, "pycoast_cache_*.png"))
         assert len(cache_glob) == 2
         assert os.path.isfile(cache_filename)

{pycoast-1.7.0 → pycoast-1.7.1}/pycoast/version.py

@@ -1,5 +1,5 @@
 
-# This file was generated by 'versioneer.py' (0.28) from
+# This file was generated by 'versioneer.py' (0.19) from
 # revision-control system data, or from the parent directory name of an
 # unpacked source archive. Distribution tarballs contain a pre-generated copy
 # of this file.
@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2023-11-30T08:53:01-0600",
+ "date": "2024-07-01T10:44:04-0500",
  "dirty": false,
  "error": null,
- "full-revisionid": "b2497177a877e25561142af580f3c0534d79397a",
- "version": "1.7.0"
+ "full-revisionid": "c526f4e2f3c1578b1c7ed95d3bfdfca49b31d1d9",
+ "version": "1.7.1"
 }
 '''  # END VERSION_JSON
 

{pycoast-1.7.0 → pycoast-1.7.1/pycoast.egg-info}/PKG-INFO

@@ -1,12 +1,9 @@
 Metadata-Version: 2.1
 Name: pycoast
-Version: 1.7.0
+Version: 1.7.1
 Summary: Writing of coastlines, borders and rivers to images in Python
-Home-page: UNKNOWN
 Author: Esben S. Nielsen
 Author-email: esn@dmi.dk
-License: UNKNOWN
-Platform: UNKNOWN
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Programming Language :: Python
@@ -14,10 +11,27 @@ Classifier: Operating System :: OS Independent
 Classifier: Intended Audience :: Science/Research
 Classifier: Topic :: Scientific/Engineering
 Requires-Python: >3.9
-Provides-Extra: docs
-Provides-Extra: tests
 License-File: LICENSE.txt
 License-File: AUTHORS.md
+Requires-Dist: aggdraw
+Requires-Dist: pyshp
+Requires-Dist: numpy
+Requires-Dist: pyproj
+Requires-Dist: pillow
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: pyresample; extra == "docs"
+Requires-Dist: pytest; extra == "docs"
+Requires-Dist: pytest-lazy-fixtures; extra == "docs"
+Requires-Dist: sphinx_rtd_theme; extra == "docs"
+Requires-Dist: sphinxcontrib-apidoc; extra == "docs"
+Provides-Extra: tests
+Requires-Dist: pyresample; extra == "tests"
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: pytest-cov; extra == "tests"
+Requires-Dist: coverage; extra == "tests"
+Requires-Dist: coveralls; extra == "tests"
+Requires-Dist: pytest-lazy-fixtures; extra == "tests"
 
 PyCoast
 =======
@@ -65,5 +79,3 @@ Example
     >>> cw.add_rivers(img, area_def, level=5, outline='blue')
     >>> cw.add_borders(img, area_def, outline=(255, 0, 0))
     >>> img.show()
-
-

{pycoast-1.7.0 → pycoast-1.7.1}/pycoast.egg-info/requires.txt

@@ -1,21 +1,21 @@
 aggdraw
+pyshp
 numpy
-pillow
 pyproj
-pyshp
+pillow
 
 [docs]
+sphinx
 pyresample
 pytest
-pytest-lazy-fixture
-sphinx
+pytest-lazy-fixtures
 sphinx_rtd_theme
 sphinxcontrib-apidoc
 
 [tests]
-coverage
-coveralls
 pyresample
 pytest
 pytest-cov
-pytest-lazy-fixture
+coverage
+coveralls
+pytest-lazy-fixtures

{pycoast-1.7.0 → pycoast-1.7.1}/pyproject.toml

@@ -14,3 +14,9 @@ exclude = '''
 )
 
 '''
+
+[tool.pytest.ini_options]
+filterwarnings = [
+    "error",
+    "ignore:numpy.ndarray size changed:RuntimeWarning",
+]

{pycoast-1.7.0 → pycoast-1.7.1}/setup.py

@@ -16,7 +16,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 """Setuptools-based packaging and installation configuration."""
 
-from setuptools import setup
+from setuptools import find_packages, setup
 
 import versioneer
 
@@ -27,11 +27,11 @@ extras_require = {
         "sphinx",
         "pyresample",
         "pytest",
-        "pytest-lazy-fixture",
+        "pytest-lazy-fixtures",
         "sphinx_rtd_theme",
         "sphinxcontrib-apidoc",
     ],
-    "tests": ["pyresample", "pytest", "pytest-cov", "coverage", "coveralls", "pytest-lazy-fixture"],
+    "tests": ["pyresample", "pytest", "pytest-cov", "coverage", "coveralls", "pytest-lazy-fixtures"],
 }
 
 with open("README", "r") as readme_file:
@@ -45,7 +45,7 @@ setup(
     long_description=long_description,
     author="Esben S. Nielsen",
     author_email="esn@dmi.dk",
-    packages=["pycoast", "pycoast.tests"],
+    packages=find_packages(),
     include_package_data=True,
     install_requires=requires,
     extras_require=extras_require,