refactor(utils.py): move language data to JSON file (resolves #52) #54

m-charlton · 2023-10-18T10:48:05Z

Contributor checklist

This pull request is on a separate branch and not the main branch

Description

Moves language meta data from python source code into an external JSON resource which is loaded when the utils module is imported.

Notes

`language-meta-data.json`

Please place attention to the comment properties: "description", "iso", "qid" & "remove-words".

`utils.py`

Couldn't think of a better name for the _find function - suggestions welcome.

Refactor language utility data out from utils.py #52

…org#52)

github-actions · 2023-10-18T10:48:33Z

Thank you for the pull request!

The Scribe team will do our best to address your contribution as soon as we can. The following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :)

If you're not already a member of our public Matrix community, please consider joining! We'd suggest using Element as your Matrix client, and definitely join the General and Data rooms once you're in. It'd be great to have you!

Maintainer checklist

The commit messages for the remote branch should be checked to make sure the contributor's email is set up correctly so that they receive credit for their contribution
- The contributor's name and icon in remote commits should be the same as what appears in the PR
- If there's a mismatch, the contributor needs to make sure that the email they use for GitHub matches what they have for git config user.email in their local Scribe-Data repo
The CHANGELOG has been updated with a description of the changes for the upcoming release (if necessary)

m-charlton · 2023-10-18T10:56:37Z

src/scribe_data/utils.py

@@ -230,7 +241,7 @@ def get_path_from_format_file() -> str:
    return "../../../../../.."


-def get_path_from_load_dir() -> str:
+def get_path_from_load_dir():


Missing return type annotation: str

m-charlton · 2023-10-21T15:30:09Z

src/scribe_data/utils.py



 def get_language_words_to_remove(language: str) -> list[str]:
    """
-    Returns the words that should not be included as autosuggestions for the given language.
+    Returns the words that should not be included as autosuggestions for the given
+    language.


No new line (combine with previous line)

m-charlton · 2023-10-21T15:30:39Z

src/scribe_data/utils.py

-        The words that should not be included as autosuggestions for the given language as values of a dictionary.
+        list[str]
+            The words that should not be included as autosuggestions for the given
+            language


No new line (combine with previous line)

m-charlton · 2023-10-21T15:31:15Z

src/scribe_data/utils.py

-        The words that should not be included as autosuggestions for the given language as values of a dictionary.
+        list[str]
+            The words that should not be included as autosuggestions for the given
+            language


No new line (combine with previous line)

@andrewtavis : This function has the same description as get_language_words_to_remove on line 189. This could be an error. One this is rectified the entry on line 9 of src/scribe_data/resources/language_meta_data.json can be updated.

Thank you! Fixed locally and will send it shortly :)

m-charlton · 2023-10-21T15:31:54Z

src/scribe_data/utils.py

@@ -349,7 +363,8 @@ def check_and_return_command_line_args(
    all_args, first_args_check=None, second_args_check=None
 ):
    """
-    Checks command line arguments passed to Scribe-Data files and returns them if correct.
+    Checks command line arguments passed to Scribe-Data files and returns them if


No new line (combine with previous line)

m-charlton · 2023-10-21T15:32:11Z

src/scribe_data/utils.py

@@ -365,7 +380,8 @@ def check_and_return_command_line_args(
    Returns
    -------
        first_args, second_args: list(str)
-            The subset of possible first and second arguments that have been verified as being valid.
+            The subset of possible first and second arguments that have been verified
+            as being valid.


No new line (combine with previous line)

andrewtavis · 2023-10-30T00:52:06Z

src/scribe_data/utils.py

-        "Spanish",
-        "Swedish",
-    ]
+    return sorted(entry["language"].capitalize() for entry in _languages)


Very nice :)

andrewtavis · 2023-10-30T00:56:01Z

src/scribe_data/utils.py

-        )
-
-    return language_qid_dict[language]
+    return _find(


This is really cool 🤩

andrewtavis · 2023-10-30T00:57:20Z

src/scribe_data/utils.py

-        )
-
-    return language_iso_dict[language]
+    return _find(


This is what I'm talking about in #55. We could basically get rid of this function and use langcodes, thus allowing us to add languages without needing to track their ISOs :)

andrewtavis · 2023-10-30T00:57:45Z

src/scribe_data/utils.py

-        raise ValueError(f"{iso.upper()} is currently not a supported ISO language.")
-
-    return iso_language_dict[iso]
+    return _find(


Similarly for this, we could remove it with #55 :)

andrewtavis · 2023-10-30T00:59:38Z

src/scribe_data/utils.py

@@ -255,7 +266,8 @@ def get_ios_data_path(language: str) -> str:

    Returns
    -------
-        The path to the data json for the given language.
+        str


Thanks for these 🙏 Definitely is good standard :)

andrewtavis

Really great, @m-charlton! Thanks for all this :) I'll do a quick sweep to get any minor fixes that remain 😊

refactor(utils.py): move language data to JSON file (resolves scribe-…

f7a38b5

…org#52)

m-charlton commented Oct 18, 2023

View reviewed changes

m-charlton commented Oct 21, 2023

View reviewed changes

andrewtavis reviewed Oct 30, 2023

View reviewed changes

src/scribe_data/utils.py

)

return language_qid_dict[language]

return _find(

Copy link

Member

andrewtavis Oct 30, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is really cool 🤩

andrewtavis reviewed Oct 30, 2023

View reviewed changes

andrewtavis approved these changes Oct 30, 2023

View reviewed changes

andrewtavis merged commit ad07bb1 into scribe-org:main Oct 30, 2023
7 checks passed

andrewtavis mentioned this pull request Oct 30, 2023

Refactor language utility data out from utils.py #52

Closed

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(utils.py): move language data to JSON file (resolves #52) #54

refactor(utils.py): move language data to JSON file (resolves #52) #54

m-charlton commented Oct 18, 2023

github-actions bot commented Oct 18, 2023 •

edited by andrewtavis

Loading

m-charlton Oct 18, 2023

m-charlton Oct 21, 2023

m-charlton Oct 21, 2023

m-charlton Oct 21, 2023 •

edited

Loading

andrewtavis Oct 30, 2023

m-charlton Oct 21, 2023

m-charlton Oct 21, 2023

andrewtavis Oct 30, 2023

andrewtavis Oct 30, 2023

andrewtavis Oct 30, 2023

andrewtavis Oct 30, 2023

andrewtavis Oct 30, 2023

andrewtavis left a comment

refactor(utils.py): move language data to JSON file (resolves #52) #54

refactor(utils.py): move language data to JSON file (resolves #52) #54

Conversation

m-charlton commented Oct 18, 2023

Contributor checklist

Description

Notes

language-meta-data.json

utils.py

github-actions bot commented Oct 18, 2023 • edited by andrewtavis Loading

Thank you for the pull request!

Maintainer checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

m-charlton Oct 21, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andrewtavis left a comment

Choose a reason for hiding this comment

`language-meta-data.json`

`utils.py`

github-actions bot commented Oct 18, 2023 •

edited by andrewtavis

Loading

m-charlton Oct 21, 2023 •

edited

Loading