Merge pull request #36 from docentYT/development

v3.1.0

Author: docentYT

.github/workflows/tests.yaml

@@ -16,7 +16,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest]
-        python-version: ['3.10', '3.11', '3.12', '3.13']
+        python-version: ['3.10', '3.11', '3.12', '3.13', '3.14']
 
     steps:
       - uses: actions/checkout@v2

CHANGELOG.md

@@ -5,6 +5,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.1.0] - 2025-10-08
+
+### Added
+- Additional tests for `api._request()`
+- Support for python 3.14
+
+### Changed
+- Exceptions for `notes.get_bbox()` (400 ValueError), `changeset.get_query()` (400 ValueError) and `changeset.upload()` (409 ChangesetAlreadyClosedOrUserIsNotAnAuthor) now will contain additional text returned by osm api [#35](https://github.com/docentYT/osm_easy_api/issues/35)
+- Use genbadge instead of coverage-badge
+
+### Fixed
+- Dependencies update
+
 ## [3.0.2] - 2025-06-19
 ### Added
 - Support for python 3.13

coverage-badge.svg

@@ -1 +1 @@
-requests==2.32.4
+requests==2.32.5

requirements.txt

@@ -27,6 +27,7 @@ classifiers =
     Programming Language :: Python :: 3.11
     Programming Language :: Python :: 3.12
     Programming Language :: Python :: 3.13
+    Programming Language :: Python :: 3.14
 
 [options]
 packages = find:

setup.cfg

@@ -1,5 +1,5 @@
 """Python package for parsing osm diffs and communicating with the OpenStreetMap api."""
-VERSION = "3.0.2"
+VERSION = "3.1.0"
 
 from . import data_classes
 from . import diff

src/osm_easy_api/__init__.py

@@ -39,6 +39,29 @@ def __init__(self, url: str = "https://master.apis.dev.openstreetmap.org", acces
             self._headers.update({"User-Agent": user_agent})
 
     def _request(self, method: _RequestMethods, url: str, stream: bool = False, files: dict | None = None, custom_status_code_exceptions: dict = {int: Exception}, body = None) -> "Response":
+        """Sends an HTTP request and handles response status codes.
+
+        Args:
+            method (_RequestMethods): The HTTP method to use (e.g. GET, POST).
+            url (str): The URL to send the request to.
+            stream (bool, optional): Whether to stream the response content. Defaults to False.
+            files (dict | None, optional): Files to include in the request. Defaults to None.
+            custom_status_code_exceptions (dict, optional): A mapping of status codes to exception types
+                used to override default behavior. Provide `-1` code to raise for all not listed status codes. 
+            body (Any, optional): The body of the request. If provided, it will be encoded in UTF-8.
+
+        Returns:
+            Response: The HTTP response object if the request was successful (status code 200).
+
+        Raises:
+            ValueError: If a mapped exception type is set and contains a string template.
+            NotImplementedError: If the status code is unexpected and no mapped exception is found.
+            Exception: If the status code matches a mapped exception in the provided or default dictionary.
+
+        Notes:
+            The method uses `self._headers` for all requests.
+            Exceptions may include response content and status code via string formatting.
+        """
         response = requests.request(str(method), url, stream=stream, files=files, data=body.encode('utf-8') if body else None, headers=self._headers)
         if response.status_code == 200: return response
 

src/osm_easy_api/api/api.py

@@ -152,7 +152,7 @@ def get_query(self, left: float | None = None, bottom: float | None = None, righ
         generator = self.outer._request_generator(
             method=self.outer._RequestMethods.GET,
             url=join_url(self.outer._url.changeset["get_query"], param),
-            custom_status_code_exceptions={400: ValueError("Invalid arguments. See https://wiki.openstreetmap.org/wiki/API_v0.6#Query:_GET_/api/0.6/changesets for more info.")})
+            custom_status_code_exceptions={400: ValueError("Invalid arguments: {TEXT}")})
 
         return self._xml_to_changesets_list(generator)
 
@@ -254,7 +254,7 @@ def upload(self, changeset_id: int, osmChange: OsmChange, make_osmChange_valid:
             custom_status_code_exceptions= {
                 400: exceptions.ErrorWhenParsingXML("{TEXT}"),
                 404: exceptions.IdNotFoundError("{TEXT}"),
-                409: exceptions.ChangesetAlreadyClosedOrUserIsNotAnAuthor(),
+                409: exceptions.ChangesetAlreadyClosedOrUserIsNotAnAuthor("{TEXT}"),
                 -1: ValueError("Unexpected but correct error. Status code: {CODE}")
             }
         )

src/osm_easy_api/api/endpoints/changeset.py

@@ -102,7 +102,7 @@ def get_bbox(self, left: str, bottom: str, right: str, top: str, limit: int = 10
         generator = self.outer._request_generator(
             method=self.outer._RequestMethods.GET,
             url=url,
-            custom_status_code_exceptions={400: ValueError("Limits exceeded")}
+            custom_status_code_exceptions={400: ValueError("Limits exceeded: {TEXT}")}
         )
 
         return self._xml_to_notes_list(generator)

src/osm_easy_api/api/endpoints/notes.py

@@ -1,4 +1,4 @@
-responses == 0.25.7
-tox == 4.27.0
-coverage == 7.9.1
-coverage-badge == 1.1.1
+responses == 0.25.8
+tox == 4.30.3
+coverage == 7.9.2
+genbadge[coverage] == 1.1.2