update .gitignore with coverage

Author: kjaymiller

.gitignore

@@ -18,3 +18,4 @@ vendor/
 test_images
 *-version
 .DS_Store
+.coverage

_conferences/__main__.py

@@ -7,39 +7,39 @@
 import gh_issues
 
 
-def get_conference_issues() -> Iterator[gh_issues.Issue]:
-    query = "repo:blackpythondevs/blackpythondevs.github.io type:issue label:conference"
+QUERY = "repo:blackpythondevs/blackpythondevs.github.io type:issue label:conference"
+
+
+def get_conference_issues(
+    query: str = QUERY,
+) -> Iterator[gh_issues.Issue]:  # pragma no cover
     issues = gh_issues.issues_by_query(query)
     return issues
 
 
-def normalize_url(url_match: str = str):
-    valid_url = None
-    # Ensure the url field is not blank and the url matches the regex
-    if url_match is not None and url_match.strip() != "":
-        # Parse the url and see if a scheme (`https`) is included in it
-        # If not, then prepend `https` to the url from the issue body
-        # This guards against the website thinking the passed in url is another page on https://blackpythondevs.com/
+def normalize_url(url_match: str | None) -> str | None:
+    """
+    Parse the url and see if a scheme (`https`) is included in it.
+    If not, then prepend `https` to the url from the issue body
+
+    This guards against the website thinking the passed in url is another page on https://blackpythondevs.com/
+    """
+    if url_match:
         parsed_url = urlparse(url_match)
 
         if "http" not in parsed_url.scheme.casefold():
-            valid_url = f"https://{url_match}"
+            return f"https://{url_match}"
         else:
-            valid_url = url_match
-
-    return valid_url
-
-
-def write_conferences_to_file(confs: list[dict]):
-    # Write the conferences to the _data/conferences.yml file
-    conferences_path.write_text(json.dumps(confs))
+            return url_match
 
 
 def __to_conference_date(conference_date: str) -> datetime.date:
     return datetime.date.fromisoformat(conference_date)
 
 
-if __name__ == "__main__":
+def parse_conference(issue: gh_issues.Issue) -> dict[str, str | None]:
+    """convert an issue to a dictionary of parsed data"""
+
     KEYS = [
         "conference_name",
         "url",
@@ -51,16 +51,31 @@ def __to_conference_date(conference_date: str) -> datetime.date:
         "speaking",
     ]
 
-    conferences = []
-    for _issue in get_conference_issues():
-        if not hasattr(_issue, "conference_end_date"):
-            continue
+    _issue = {k: getattr(issue, k, None) for k in KEYS}
+    _issue["url"] = normalize_url(_issue.get("url", None))
+    return _issue
+
+
+def _validate_issue(issue: gh_issues.Issue, date_to_check: str):
+    """Validate an issue based on its `date_to_check`"""
+    if not (valid_date := getattr(issue, date_to_check, False)):
+        return False
+    else:
+        return __to_conference_date(valid_date) >= datetime.date.today()
+
+
+def build_conferences() -> list[dict[str, str | None]]:  # pragma: no cover
+    return [
+        parse_conference(issue)
+        for issue in get_conference_issues()
+        if _validate_issue(issue, "conference_end_date")
+    ]
 
-        if __to_conference_date(_issue.conference_end_date) >= datetime.date.today():
-            conferences.append({k: getattr(_issue, k, None) for k in KEYS})
 
+if __name__ == "__main__":  # pragma: no cover
     ROOT = pathlib.Path(__file__).parent.parent
     conferences_path = ROOT.joinpath("_data/conferences.json")
+    conferences = build_conferences()
     conferences_path.write_text(
         json.dumps(
             list(

_data/conferences.json

@@ -1,7 +1,7 @@
 [
   {
     "conference_name": "PyconUg",
-    "url": "ug.pycon.org",
+    "url": "https://ug.pycon.org",
     "conference_start_date": "2024-10-09",
     "conference_end_date": "2024-10-13",
     "conference_type": "in-person",
@@ -19,5 +19,4 @@
     "summary": "PyHo, champion the leverage of Python in education promote diversity and inclusion from underrepresented communities within\nthe/beyond our region. Provide the foundational platform for new and experienced speakers alike to share ideas and resources.",
     "speaking": null
   }
-]
-
+]

requirements-dev.txt

@@ -2,6 +2,7 @@ black
 ephemeral_port_reserve
 gh-issues
 pre-commit
+pytest-mock
 pytest-pyodide
 pytest-playwright
 pytest-xprocess

tests/test.py

@@ -2,7 +2,6 @@
 
 import pytest
 from xprocess import ProcessStarter
-from _conferences.__main__ import parse_conference_details
 from playwright.sync_api import Page, expect, sync_playwright
 
 
@@ -100,113 +99,3 @@ def test_mailto_bpdevs(page_url: tuple[Page, str]) -> None:
     page.goto(live_server_url)
     mailto = page.get_by_role("link", name="email")
     expect(mailto).to_have_attribute("href", "mailto:[email protected]")
-
-
-def test_conference_parsing_valid_url():
-    example_conf_issue = """### Conference Name
-
-Test Conference Title
-
-### URL
-
-https://microsoft.com
-
-### Conference Dates
-
-10 - 15 Sep 2050
-
-### Conference Type
-
-both
-
-### Conference Location
-
-Redmond, WA, USA
-
-### Summary
-
-Test Conference Summary
-
-### Speaking
-
-* [Satya Nadella](https://www.linkedin.com/in/satyanadella/)
-"""
-    expected_name = "Test Conference Title"
-    expected_url = "https://microsoft.com"
-    parsed_conf = parse_conference_details(issue_body=example_conf_issue)
-
-    assert parsed_conf["name"] == expected_name
-    assert parsed_conf["url"] == expected_url
-
-
-def test_conference_parsing_logic_no_url_scheme():
-    example_conf_issue = """### Conference Name
-
-Test Conference Title
-
-### URL
-
-microsoft.com
-
-### Conference Dates
-
-10 - 15 Sep 2050
-
-### Conference Type
-
-both
-
-### Conference Location
-
-Redmond, WA, USA
-
-### Summary
-
-Test Conference Summary
-
-### Speaking
-
-* [Satya Nadella](https://www.linkedin.com/in/satyanadella/)
-"""
-    expected_name = "Test Conference Title"
-    expected_url = "https://microsoft.com"
-    parsed_conf = parse_conference_details(issue_body=example_conf_issue)
-
-    assert parsed_conf["name"] == expected_name
-    assert parsed_conf["url"] == expected_url
-
-
-def test_conference_parsing_logic_no_url():
-    example_conf_issue = """### Conference Name
-
-Test Conference Title
-
-### URL
-
-
-### Conference Dates
-
-10 - 15 Sep 2050
-
-### Conference Type
-
-both
-
-### Conference Location
-
-Redmond, WA, USA
-
-### Summary
-
-Test Conference Summary
-
-### Speaking
-
-* [Satya Nadella](https://www.linkedin.com/in/satyanadella/)
-"""
-    expected_name = "Test Conference Title"
-    expected_url = None
-    parsed_conf = parse_conference_details(issue_body=example_conf_issue)
-
-    assert parsed_conf["name"] == expected_name
-    assert parsed_conf["url"] == expected_url