Remove log helper and use logging directly (#63)

* Remove log helper and use logging directly * add changelog
GateNLP · Jan 29, 2025 · 957bf07 · 957bf07
1 parent a9d9169
commit 957bf07
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 85 deletions.
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -7,6 +7,7 @@ Upcoming
 **Bug Fixes**
 
 - Changed log level when a suspected gzipped sitemap can't be un-gzipped from `error` to `warning`, since parsing can usually continue (:pr:`62` by :user:`redreceipt`)
+- Line references in logs now reference the correct location instead of lines within the logging helper file (:pr`63`)
 
 v1.1.0 (2025-01-20)
 -------------------

diff --git a/usp/fetch_parse.py b/usp/fetch_parse.py
@@ -13,7 +13,7 @@
 from collections import OrderedDict
 from decimal import Decimal, InvalidOperation
 from typing import Optional, Dict, Union
-
+import logging
 
 from .exceptions import SitemapException, SitemapXMLParsingException
 from .helpers import (
@@ -24,7 +24,6 @@
     is_http_url,
     parse_rfc2822_date,
 )
-from .log import create_logger
 from .objects.page import (
     SitemapImage,
     SitemapPage,
@@ -50,7 +49,7 @@
 from .web_client.abstract_client import LocalWebClient, NoWebClientException
 from .web_client.requests_client import RequestsWebClient
 
-log = create_logger(__name__)
+log = logging.getLogger(__name__)
 
 
 class SitemapFetcher:

diff --git a/usp/helpers.py b/usp/helpers.py
@@ -3,6 +3,7 @@
 import datetime
 import gzip as gzip_lib
 import html
+import logging
 import re
 import sys
 import time
@@ -12,15 +13,14 @@
 from dateutil.parser import isoparse as dateutil_isoparse
 
 from .exceptions import SitemapException, GunzipException, StripURLToHomepageException
-from .log import create_logger
 from .web_client.abstract_client import (
     AbstractWebClient,
     AbstractWebClientSuccessResponse,
     WebClientErrorResponse,
     AbstractWebClientResponse,
 )
 
-log = create_logger(__name__)
+log = logging.getLogger(__name__)
 
 __URL_REGEX = re.compile(r"^https?://[^\s/$.?#].[^\s]*$", re.IGNORECASE)
 """Regular expression to match HTTP(s) URLs."""

diff --git a/usp/log.py b/usp/log.py
diff --git a/usp/tree.py b/usp/tree.py
@@ -1,10 +1,10 @@
 """Helpers to generate a sitemap tree."""
 
+import logging
 from typing import Optional
 from .exceptions import SitemapException
 from .fetch_parse import SitemapFetcher, SitemapStrParser
 from .helpers import is_http_url, strip_url_to_homepage
-from .log import create_logger
 from .objects.sitemap import (
     AbstractSitemap,
     InvalidSitemap,
@@ -13,7 +13,7 @@
 )
 from .web_client.abstract_client import AbstractWebClient
 
-log = create_logger(__name__)
+log = logging.getLogger(__name__)
 
 _UNPUBLISHED_SITEMAP_PATHS = {
     "sitemap.xml",

diff --git a/usp/web_client/requests_client.py b/usp/web_client/requests_client.py
@@ -16,6 +16,8 @@
 )
 from usp import __version__
 
+log = logging.getLogger(__name__)
+
 
 class RequestsWebClientSuccessResponse(AbstractWebClientSuccessResponse):
     """
@@ -153,7 +155,7 @@ def get(self, url: str) -> AbstractWebClientResponse:
                 )
             else:
                 message = f"{response.status_code} {response.reason}"
-                logging.info(f"Response content: {response.text}")
+                log.info(f"Response content: {response.text}")
 
                 if response.status_code in RETRYABLE_HTTP_STATUS_CODES:
                     return RequestsWebClientErrorResponse(