Refactoring: uniform use of keyword cred_filepath

Author: LukasGold

examples/create_page_package.py

@@ -47,7 +47,7 @@
 # Provide the information needed (only) to create the page package
 config = Package.CreationConfig(
     # Specify the path to the credentials file
-    credentials_file_path=Path(__file__).parent / "accounts.pwd.yaml",
+    cred_filepath=Path(__file__).parent / "accounts.pwd.yaml",
     # Specify the domain of the OSW/OSL instance to load pages from
     domain="wiki-dev.open-semantic-lab.org",
     # Specify the path to the working directory - where the package is stored on disk

examples/gui_local_slot_editing.py

@@ -33,7 +33,7 @@
 SETTINGS_FILE_PATH_DEFAULT = os.path.join(
     os.path.dirname(os.path.abspath(__file__)), "settings.json"
 )
-CREDENTIALS_FILE_PATH_DEFAULT = os.path.join(
+CRED_FILEPATH_DEFAULT = os.path.join(
     os.path.dirname(os.path.abspath(__file__)), "accounts.pwd.yaml"
 )
 PACKAGE_INFO_FILE_NAME = "packages.json"
@@ -144,7 +144,7 @@ def save_as_page_package(
         settings_read_from_file = True
     else:
         settings = {
-            "credentials_file_path": str(CREDENTIALS_FILE_PATH_DEFAULT),
+            "cred_filepath": str(CRED_FILEPATH_DEFAULT),
             "local_working_directory": str(LWD_DEFAULT),
             "settings_file_path": str(SETTINGS_FILE_PATH_DEFAULT),
             "target_page": TARGET_PAGE_DEFAULT,
@@ -156,17 +156,15 @@ def save_as_page_package(
         }
         settings_read_from_file = False
 
-    domains, accounts = read_domains_from_credentials_file(
-        settings["credentials_file_path"]
-    )
+    domains, accounts = read_domains_from_credentials_file(settings["cred_filepath"])
     if "wiki-dev.open-semantic-lab.org" in domains:
         domain = "wiki-dev.open-semantic-lab.org"
     else:
         domain = domains[0]
     if settings_read_from_file:
         settings["domain"] = domain
 
-    cm = CredentialManager(cred_filepath=settings["credentials_file_path"])
+    cm = CredentialManager(cred_filepath=settings["cred_filepath"])
     osw_obj = OswExpress(domain=domain, cred_mngr=cm)
     wtsite_obj = osw_obj.site
 
@@ -215,7 +213,7 @@ def save_as_page_package(
                             size=(50, 1),
                             enable_events=True,
                             key="-CREDENTIALS-",
-                            default_text=settings["credentials_file_path"],
+                            default_text=settings["cred_filepath"],
                         ),
                         psg.FileBrowse(
                             button_text="Browse", key="-BROWSE_CREDENTIALS-"
@@ -352,7 +350,7 @@ def save_as_page_package(
             with open(settings["settings_file_path"], "r") as f:
                 settings = json.load(f)
             # update GUI
-            window["-CREDENTIALS-"].update(settings["credentials_file_path"])
+            window["-CREDENTIALS-"].update(settings["cred_filepath"])
             window["-LWD-"].update(settings["local_working_directory"])
             window["-DOMAIN-"].update(settings["domain"])
             window["-ADDRESS-"].update(settings["target_page"])
@@ -369,9 +367,9 @@ def save_as_page_package(
             with open(settings["settings_file_path"], "w") as f:
                 json.dump(settings, f, indent=4)
         elif event == "-CREDENTIALS-":
-            settings["credentials_file_path"] = values["-CREDENTIALS-"]
+            settings["cred_filepath"] = values["-CREDENTIALS-"]
             domains, accounts = read_domains_from_credentials_file(
-                settings["credentials_file_path"]
+                settings["cred_filepath"]
             )
             window["-DOMAIN-"].update(values=domains)
         elif event == "-LWD-":

examples/inter_osw_copy_page.py

@@ -14,17 +14,17 @@
 
 class OswInstance(OswBaseModel):
     domain: str
-    cred_fp: Union[str, Path]
+    cred_filepath: Union[str, Path]
     credentials_manager: Optional[CredentialManager]
     osw: Optional[OSW]
     wtsite: Optional[WtSite]
 
     class Config:
         arbitrary_types_allowed = True
 
-    def __init__(self, domain: str, cred_fp: Union[str, Path]):
-        super().__init__(**{"domain": domain, "cred_fp": cred_fp})
-        self.credentials_manager = CredentialManager(cred_filepath=cred_fp)
+    def __init__(self, domain: str, cred_filepath: Union[str, Path]):
+        super().__init__(**{"domain": domain, "cred_filepath": cred_filepath})
+        self.credentials_manager = CredentialManager(cred_filepath=cred_filepath)
         self.osw = OSW(
             site=WtSite(
                 WtSite.WtSiteConfig(iri=domain, cred_mngr=self.credentials_manager)
@@ -115,20 +115,20 @@ def copy_pages_from(
     source_domain: str,
     to_target_domains: List[str],
     page_titles: List[str],
-    cred_fp: Union[str, Path],
+    cred_filepath: Union[str, Path],
     comment: str = None,
     overwrite: bool = False,
 ):
     if comment is None:
         comment = f"[bot edit] Copied from {source_domain}"
     osw_source = OswInstance(
         domain=source_domain,
-        cred_fp=cred_fp,
+        cred_filepath=cred_filepath,
     )
     osw_targets = [
         OswInstance(
             domain=domain,
-            cred_fp=cred_fp,
+            cred_filepath=cred_filepath,
         )
         for domain in to_target_domains
     ]
@@ -150,7 +150,7 @@ def copy_pages_from(
 
 
 if __name__ == "__main__":
-    credentials_fp = Path(r"accounts.pwd.yaml")
+    cred_filepath_ = Path(r"accounts.pwd.yaml")
     source = "onto-wiki.eu"
     targets = ["wiki-dev.open-semantic-lab.org"]
     titles = [
@@ -164,26 +164,26 @@ def copy_pages_from(
             source_domain=source,
             to_target_domains=targets,
             page_titles=titles,
-            cred_fp=credentials_fp,
+            cred_filepath=cred_filepath_,
             overwrite=True,
         )
     # Implementation within wtsite
     use_wtsite = True
     if use_wtsite:
-        osw_source = OswInstance(
+        osw_source_ = OswInstance(
             domain=source,
-            cred_fp=credentials_fp,
+            cred_filepath=cred_filepath_,
         )
-        osw_targets = [
+        osw_targets_ = [
             OswInstance(
                 domain=target,
-                cred_fp=credentials_fp,
+                cred_filepath=cred_filepath_,
             )
             for target in targets
         ]
-        source_site = osw_source.wtsite
-        target_sites = [osw_target.wtsite for osw_target in osw_targets]
-        result = {}
+        source_site = osw_source_.wtsite
+        target_sites: List[WtSite] = [osw_target.wtsite for osw_target in osw_targets_]
+        result_ = {}
         for target_site in target_sites:
             target = target_site.mw_site.host
             copied_pages = target_site.copy_pages(
@@ -194,4 +194,4 @@ def copy_pages_from(
                     parallel=False,
                 )
             )
-            result[target] = copied_pages
+            result_[target] = copied_pages

examples/settings.example.json

@@ -1,6 +1,6 @@
 {
     "local_working_directory": "C:\\Users\\gold\\github\\osw-python\\data",
-    "credentials_file_path": "C:/Users/gold/github/osw-python/examples/accounts.pwd.yaml",
+    "cred_filepath": "C:/Users/gold/github/osw-python/examples/accounts.pwd.yaml",
     "settings_file_path": "C:\\Users\\gold\\github\\osw-python\\examples\\settings.json",
     "target_page": "https://wiki-dev.open-semantic-lab.org/wiki/Main_Page",
     "namespace_as_folder": false,

examples/use_express_functions.py

@@ -13,7 +13,7 @@
 # cred_filepath_default.set_default(r"C:\Users\gold\ownCloud\Personal\accounts.pwd.yaml")
 
 # Check setting
-print(f"Credentials loaded from '{str(default_paths.cred_fp)}'")
+print(f"Credentials loaded from '{str(default_paths.cred_filepath)}'")
 
 # The domain to connect to
 domain = "wiki-dev.open-semantic-lab.org"

src/osw/auth.py

@@ -85,7 +85,7 @@ def __init__(self, **data):
         if self.cred_filepath:
             if not isinstance(self.cred_filepath, list):
                 self.cred_filepath = [self.cred_filepath]
-        # Make sure to at least warn the user if they pass cred_fp instead of
+        # Make sure to at least warn the user if they pass cred_filepath instead of
         # cred_filepath
         attribute_names = self.__dict__.keys()
         unexpected_kwargs = [key for key in data.keys() if key not in attribute_names]
@@ -257,7 +257,7 @@ def save_credentials_to_file(
         if filepath is None:
             cred_filepaths = self.cred_filepath
             if self.cred_filepath is None:
-                cred_filepaths = [default_paths.cred_fp]
+                cred_filepaths = [default_paths.cred_filepath]
         if set_cred_filepath:
             # Creates error if file does not exist -> Using custom FilePath
             self.cred_filepath = cred_filepaths

src/osw/controller/page_package.py

@@ -361,7 +361,7 @@ class CreationConfig(OswBaseModel):
 
         domain: str
         """A string formatted as domain"""
-        credentials_file_path: Union[str, FilePath]
+        cred_filepath: Union[str, FilePath]
         """Path to a existing credentials yaml files"""
         working_dir: Union[str, Path]
         """Working directory. Will be created automatically if not existing."""
@@ -386,7 +386,7 @@ def create(
             WtSite.WtSiteConfig(
                 iri=creation_config.domain,
                 cred_mngr=CredentialManager(
-                    cred_filepath=creation_config.credentials_file_path
+                    cred_filepath=creation_config.cred_filepath
                 ),
             )
         )
@@ -676,7 +676,7 @@ def recursive(
                     WtSite.WtSiteConfig(
                         iri=params.creation_config.domain,
                         cred_mngr=CredentialManager(
-                            cred_filepath=params.creation_config.credentials_file_path
+                            cred_filepath=params.creation_config.cred_filepath
                         ),
                     )
                 )

src/osw/data/import_utility.py

@@ -758,7 +758,7 @@ def create_page_name_from_label(label: str) -> str:
 def get_entities_from_osw(
     category_to_search: Union[str, uuid_module.UUID],
     model_to_cast_to,
-    credentials_fp,
+    cred_filepath,
     domain,
     osw_obj: OSW = None,
     debug: bool = False,
@@ -773,8 +773,12 @@ def get_entities_from_osw(
         Category to search for.
     model_to_cast_to:
         Model to cast the entities to.
-    credentials_fp:
+    cred_filepath:
         Filepath to the credentials file, used to access the OSW instance.
+    domain:
+        Domain of the OSW instance.
+    osw_obj:
+        OSW instance to use. If None, a new instance is created.
     debug:
         If True, prints debug information.
 
@@ -799,7 +803,7 @@ def test_if_empty_list_or_none(obj) -> bool:
     else:  # elif isinstance(category_to_search, uuid_module.UUID):
         category_uuid = str(category_to_search)
     if osw_obj is None:
-        cred_man = CredentialManager(cred_filepath=credentials_fp)
+        cred_man = CredentialManager(cred_filepath=cred_filepath)
         osw_obj = OSW(site=WtSite(WtSite.WtSiteConfig(iri=domain, cred_mngr=cred_man)))
     wtsite_obj = osw_obj.site
     entities_from_osw = []
@@ -870,16 +874,16 @@ def create_full_page_title(
 
 def translate_list_with_deepl(
     seq: list,
-    credentials_file_path: Union[str, Path] = None,
+    cred_filepath: Union[str, Path] = None,
     target_lang: str = "EN-US",
     translations: dict = None,
 ) -> dict:
     """Translates a list of strings with DeepL."""
-    if credentials_file_path is None:
-        credentials_file_path = default_paths.cred_fp
+    if cred_filepath is None:
+        cred_filepath = default_paths.cred_filepath
     if translations is None:
         translations = {}
-    domains, accounts = wt.read_domains_from_credentials_file(credentials_file_path)
+    domains, accounts = wt.read_domains_from_credentials_file(cred_filepath)
     domain = "api-free.deepl.com"
     auth = accounts[domain]["password"]
     translator = deepl.Translator(auth)

src/osw/defaults.py

@@ -12,8 +12,8 @@
 BASE_PATH = Path.cwd()
 OSW_FILES_DIR_DEFAULT = BASE_PATH / "osw_files"
 DOWNLOAD_DIR_DEFAULT = OSW_FILES_DIR_DEFAULT / "downloads"
-CREDENTIALS_FN_DEFAULT = "credentials.pwd.yaml"
-CREDENTIALS_FP_DEFAULT = OSW_FILES_DIR_DEFAULT / CREDENTIALS_FN_DEFAULT
+CRED_FILENAME_DEFAULT = "credentials.pwd.yaml"
+CRED_FILEPATH_DEFAULT = OSW_FILES_DIR_DEFAULT / CRED_FILENAME_DEFAULT
 WIKI_DOMAIN_DEFAULT = "wiki.open-semantic-lab.org"
 
 
@@ -62,9 +62,9 @@ class Paths(OswBaseModel):
     osw_files_dir: Path = OSW_FILES_DIR_DEFAULT
     """If you want to specify the default OSW files directory, use
     Path.osw_files_dir = new_path."""
-    cred_fp: Path = CREDENTIALS_FP_DEFAULT
+    cred_filepath: Path = CRED_FILEPATH_DEFAULT
     """If you want to specify the saving location of the credentials file, use
-    Path.cred_fp = new_path."""
+    Path.cred_filepath = new_path."""
     download_dir: Path = DOWNLOAD_DIR_DEFAULT
     """If you want to specify the default download directory, use
     Path.download_dir = new_path."""
@@ -119,13 +119,13 @@ def update_attr(set_attr, to_update, old_val, new_val):
         if attr_name == "base":
             update_attr(
                 "base",
-                ["osw_files_dir", "cred_fp", "download_dir"],
+                ["osw_files_dir", "cred_filepath", "download_dir"],
                 old_value,
                 new_value,
             )
         elif attr_name == "osw_files_dir":
             update_attr(
-                "osw_files_dir", ["cred_fp", "download_dir"], old_value, new_value
+                "osw_files_dir", ["cred_filepath", "download_dir"], old_value, new_value
             )
 
 

src/osw/express.py

@@ -71,7 +71,7 @@ def __init__(
         cred_mngr: CredentialManager = None,
     ):
         if cred_filepath is None:
-            cred_filepath = default_paths.cred_fp
+            cred_filepath = default_paths.cred_filepath
             if cred_mngr is not None:
                 if cred_mngr.cred_filepath is not None:
                     cred_filepath = cred_mngr.cred_filepath[0]
@@ -381,7 +381,9 @@ def import_with_fallback(
             domain = input("Please enter the domain of the OSW instance to connect to:")
         if domain == "" or domain is None:
             domain = default_params.wiki_domain
-        osw_express = OswExpress(domain=domain, cred_filepath=default_paths.cred_fp)
+        osw_express = OswExpress(
+            domain=domain, cred_filepath=default_paths.cred_filepath
+        )
 
         osw_express.install_dependencies(dependencies, mode="append")
         osw_express.shut_down()  # Avoiding connection error
@@ -523,7 +525,7 @@ def process_init_data(self, data: Dict[str, Any]) -> Dict[str, Any]:
             # set by the source file controller
             del data["label"]
         if data.get("cred_filepath") is None:
-            data["cred_filepath"] = default_paths.cred_fp
+            data["cred_filepath"] = default_paths.cred_filepath
         if not data.get("cred_filepath").parent.exists():
             data["cred_filepath"].parent.mkdir(parents=True)
         if data.get("cred_mngr") is None: