Fix: Uniform use of OSW_DOMAIN or OSL_DOMAIN instead of OSW_WIKI_DOMAIN and OSL_WIKI_DOMAIN

Author: LukasGold

examples/.env_example

@@ -1,3 +1,3 @@
-OSW_WIKI_DOMAIN=wiki-dev.open-semantic-lab.org
+OSW_DOMAIN=wiki-dev.open-semantic-lab.org
 OSW_CRED_FILEPATH=/path/to/credentials/file
 OSW_DOWNLOAD_DIR=/path/to/download/directory

examples/use_express_functions.py

@@ -9,7 +9,7 @@
 dotenv.load_dotenv()  # will look for a .env file in CWD and above
 
 # (Alternative) Setting the domain of the wiki to connect to
-os.environ["OSW_WIKI_DOMAIN"] = "wiki-dev.open-semantic-lab.org"
+os.environ["OSW_DOMAIN"] = "wiki-dev.open-semantic-lab.org"
 # (Optional) Set the default credentials filepath to desired location. Otherwise,
 #  it will use the default location (current working directory)
 os.environ["OSW_CRED_FILEPATH"] = str(

src/osw/express.py

@@ -4,11 +4,11 @@
 
 This module expects environment variables to be set and available, e.g. through
 dotenv.load_dotenv()
-- OSW_WIKI_DOMAIN: domain of the OSL instance to connect to
-- OSW_CRED_FILEPATH: filepath to the credential file, if not specified the default
-file path based on current working directory will be used
-- OSW_DOWNLOAD_DIR: directory to download files, if not specified the default
-directory based on the current working directory will be used
+- OSW_DOMAIN: domain of the OSL instance to connect to
+- OSW_CRED_FILEPATH: filepath to the credential file, otherwise falls back to the
+default file path, which is based on current working directory
+- OSW_DOWNLOAD_DIR: directory to download files, otherwise falls back to the default
+directory, which is based on the current working directory
 """
 
 import importlib.util
@@ -98,10 +98,10 @@ def __init__(
         cred_mngr: CredentialManager = None,
     ):
         if domain is None:
-            if os.getenv("OSW_WIKI_DOMAIN") is not None:
-                domain = os.getenv("OSW_WIKI_DOMAIN")
-            elif os.getenv("OSL_WIKI_DOMAIN") is not None:
-                domain = os.getenv("OSL_WIKI_DOMAIN")
+            if os.getenv("OSW_DOMAIN") is not None:
+                domain = os.getenv("OSW_DOMAIN")
+            elif os.getenv("OSL_DOMAIN") is not None:
+                domain = os.getenv("OSL_DOMAIN")
             else:
                 raise TypeError(
                     "The constructor of OswExpress is missing 1 required positional "
@@ -336,7 +336,7 @@ class FileResult(OswBaseModel):
     domain: Optional[str] = None
     """The domain of the OSL instance to download the file from. Required if
     urL_or_title is a full page title and the domain is not set in the environment
-    variable 'OSW_WIKI_DOMAIN'. If None the domain is parsed from the URL."""
+    variable 'OSW_DOMAIN'. If None the domain is parsed from the URL."""
     cred_filepath: Optional[Union[str, Path]] = None
     """The filepath to the credentials file. Will only be used if cred_mngr is
     None. If cred_filepath is None, a credentials file named 'accounts.pwd.yaml' is
@@ -491,10 +491,10 @@ def __init__(self, url_or_title, **data):
                 string=url_or_title,
             )
             if match is None:
-                if os.getenv("OSW_WIKI_DOMAIN") is not None:
-                    data["domain"] = os.getenv("OSW_WIKI_DOMAIN")
-                elif os.getenv("OSL_WIKI_DOMAIN") is not None:
-                    data["domain"] = os.getenv("OSL_WIKI_DOMAIN")
+                if os.getenv("OSW_DOMAIN") is not None:
+                    data["domain"] = os.getenv("OSW_DOMAIN")
+                elif os.getenv("OSL_DOMAIN") is not None:
+                    data["domain"] = os.getenv("OSL_DOMAIN")
                 else:
                     raise ValueError(
                         f"Could not parse domain from URL: {url_or_title}. "
@@ -574,7 +574,7 @@ def osw_download_file(
     domain
         The domain of the OSL instance to download the file from. Required if
         urL_or_title is a full page title and the domain is not set in the environment
-        variable 'OSW_WIKI_DOMAIN'. If None the domain is parsed from the URL.
+        variable 'OSW_DOMAIN'. If None the domain is parsed from the URL.
     cred_filepath
         The filepath to the credentials file. Will only be used if cred_mngr is
          None. If cred_filepath is None, a credentials file named 'accounts.pwd.yaml'
@@ -695,9 +695,7 @@ def __init__(
                 if match is not None:
                     data["domain"] = match.group(1)
                 else:
-                    data["domain"] = os.getenv("OSW_WIKI_DOMAIN") or os.getenv(
-                        "OSL_WIKI_DOMAIN"
-                    )
+                    data["domain"] = os.getenv("OSW_DOMAIN") or os.getenv("OSL_DOMAIN")
             else:
                 if match is not None:
                     if not data.get("domain") == match.group(1):
@@ -964,10 +962,10 @@ def import_with_fallback(
         # todo: should  this be taken from globals?
         # If the user has set the default domain, use it
         if domain is None:
-            if os.getenv("OSW_WIKI_DOMAIN") is not None:
-                domain = os.getenv("OSW_WIKI_DOMAIN")
-            elif os.getenv("OSL_WIKI_DOMAIN") is not None:
-                domain = os.getenv("OSL_WIKI_DOMAIN")
+            if os.getenv("OSW_DOMAIN") is not None:
+                domain = os.getenv("OSW_DOMAIN")
+            elif os.getenv("OSL_DOMAIN") is not None:
+                domain = os.getenv("OSL_DOMAIN")
             elif default_params.has_changed("wiki_domain"):
                 domain = default_params.wiki_domain
             else:

tests/integration/test_express.py

@@ -95,7 +95,7 @@ def test_init_from_env_vars(wiki_domain, wiki_username, wiki_password):
     cred_filepath = Path.cwd() / "accounts.pwd.yaml"
     os.environ["OSW_CRED_FILEPATH"] = str(cred_filepath)
     create_credentials_file(cred_filepath, wiki_domain, wiki_username, wiki_password)
-    os.environ["OSW_WIKI_DOMAIN"] = wiki_domain
+    os.environ["OSW_DOMAIN"] = wiki_domain
 
     osw_express = osw.express.OswExpress()
     osw_express_and_credentials(osw_express, wiki_domain, wiki_username, wiki_password)

tests/integration/test_express_init.py

@@ -70,8 +70,8 @@ def clean_env_vars(*var_names):
 
 
 ENV_VARS = [
-    "OSW_WIKI_DOMAIN",
-    "OSL_WIKI_DOMAIN",
+    "OSW_DOMAIN",
+    "OSL_DOMAIN",
     "OSW_CRED_FILEPATH",
     "OSL_CRED_FILEPATH",
 ]
@@ -186,13 +186,12 @@ class TestInitEnvVarPriority:
     """Test that OSW_* env vars take priority over OSL_* env vars."""
 
     def test_osw_domain_takes_priority_over_osl(self, mocker):
-        """When both OSW_WIKI_DOMAIN and OSL_WIKI_DOMAIN are set,
-        OSW_WIKI_DOMAIN should be used."""
+        """When both OSW_DOMAIN and OSL_DOMAIN are set, OSW_DOMAIN should be used."""
         with clean_env_vars(*ENV_VARS):
             osw_domain = "osw.example.com"
             osl_domain = "osl.example.com"
-            os.environ["OSW_WIKI_DOMAIN"] = osw_domain
-            os.environ["OSL_WIKI_DOMAIN"] = osl_domain
+            os.environ["OSW_DOMAIN"] = osw_domain
+            os.environ["OSL_DOMAIN"] = osl_domain
 
             cred_filepath = Path.cwd() / "test_priority_accounts.pwd.yaml"
             create_credentials_file(cred_filepath, osw_domain, "user", "pass")
@@ -213,10 +212,10 @@ def test_osw_domain_takes_priority_over_osl(self, mocker):
                     cred_filepath.unlink()
 
     def test_osl_domain_used_when_osw_absent(self, mocker):
-        """When only OSL_WIKI_DOMAIN is set, it should be used."""
+        """When only OSL_DOMAIN is set, it should be used."""
         with clean_env_vars(*ENV_VARS):
             osl_domain = "osl.example.com"
-            os.environ["OSL_WIKI_DOMAIN"] = osl_domain
+            os.environ["OSL_DOMAIN"] = osl_domain
 
             cred_filepath = Path.cwd() / "test_osl_accounts.pwd.yaml"
             create_credentials_file(cred_filepath, osl_domain, "user", "pass")
@@ -239,7 +238,7 @@ def test_osw_cred_filepath_takes_priority_over_osl(self, mocker):
         OSW_CRED_FILEPATH should be used."""
         with clean_env_vars(*ENV_VARS):
             domain = "priority.example.com"
-            os.environ["OSW_WIKI_DOMAIN"] = domain
+            os.environ["OSW_DOMAIN"] = domain
 
             osw_cred_fp = Path.cwd() / "test_osw_cred.pwd.yaml"
             osl_cred_fp = Path.cwd() / "test_osl_cred.pwd.yaml"
@@ -336,7 +335,7 @@ def test_live_init_from_osl_env_vars(
             create_credentials_file(
                 cred_filepath, wiki_domain, wiki_username, wiki_password
             )
-            os.environ["OSL_WIKI_DOMAIN"] = wiki_domain
+            os.environ["OSL_DOMAIN"] = wiki_domain
             os.environ["OSL_CRED_FILEPATH"] = str(cred_filepath)
 
             try:
@@ -566,9 +565,9 @@ def test_domain_parsed_from_url(self, tmp_path, mocker):
             assert result.domain == "wiki.example.com"
 
     def test_domain_from_osw_env_var(self, tmp_path, mocker):
-        """When url_or_title is a title and OSW_WIKI_DOMAIN is set."""
+        """When url_or_title is a title and OSW_DOMAIN is set."""
         with clean_env_vars(*self.DOWNLOAD_ENV_VARS):
-            os.environ["OSW_WIKI_DOMAIN"] = "env.example.com"
+            os.environ["OSW_DOMAIN"] = "env.example.com"
             mock_osw, cred_fp = self._make_download_mocks(mocker, tmp_path)
             target_fp = tmp_path / "SomeFile.txt"
             result = DownloadFileResult(
@@ -580,9 +579,9 @@ def test_domain_from_osw_env_var(self, tmp_path, mocker):
             assert result.domain == "env.example.com"
 
     def test_domain_from_osl_env_var(self, tmp_path, mocker):
-        """When url_or_title is a title and only OSL_WIKI_DOMAIN is set."""
+        """When url_or_title is a title and only OSL_DOMAIN is set."""
         with clean_env_vars(*self.DOWNLOAD_ENV_VARS):
-            os.environ["OSL_WIKI_DOMAIN"] = "osl-env.example.com"
+            os.environ["OSL_DOMAIN"] = "osl-env.example.com"
             mock_osw, cred_fp = self._make_download_mocks(mocker, tmp_path)
             target_fp = tmp_path / "SomeFile.txt"
             result = DownloadFileResult(
@@ -596,7 +595,7 @@ def test_domain_from_osl_env_var(self, tmp_path, mocker):
     def test_target_dir_from_osw_env_var(self, tmp_path, mocker):
         """When OSW_DOWNLOAD_DIR is set, it should be used as target_dir."""
         with clean_env_vars(*self.DOWNLOAD_ENV_VARS):
-            os.environ["OSW_WIKI_DOMAIN"] = "env.example.com"
+            os.environ["OSW_DOMAIN"] = "env.example.com"
             download_dir = str(tmp_path / "downloads")
             os.environ["OSW_DOWNLOAD_DIR"] = download_dir
             mock_osw, cred_fp = self._make_download_mocks(mocker, tmp_path)
@@ -610,7 +609,7 @@ def test_target_dir_from_osw_env_var(self, tmp_path, mocker):
     def test_target_dir_from_osl_env_var(self, tmp_path, mocker):
         """When only OSL_DOWNLOAD_DIR is set, it should be used."""
         with clean_env_vars(*self.DOWNLOAD_ENV_VARS):
-            os.environ["OSW_WIKI_DOMAIN"] = "env.example.com"
+            os.environ["OSW_DOMAIN"] = "env.example.com"
             download_dir = str(tmp_path / "osl_downloads")
             os.environ["OSL_DOWNLOAD_DIR"] = download_dir
             mock_osw, cred_fp = self._make_download_mocks(mocker, tmp_path)
@@ -642,7 +641,7 @@ def test_use_cached_with_existing_file(self, tmp_path):
     def test_target_fn_derived_from_title(self, tmp_path, mocker):
         """The target filename should be derived from the title after 'File:'."""
         with clean_env_vars(*self.DOWNLOAD_ENV_VARS):
-            os.environ["OSW_WIKI_DOMAIN"] = "env.example.com"
+            os.environ["OSW_DOMAIN"] = "env.example.com"
             mock_osw, cred_fp = self._make_download_mocks(mocker, tmp_path)
             result = DownloadFileResult(
                 url_or_title="File:MyDocument.pdf",
@@ -977,7 +976,7 @@ class TestUploadDomainFromEnv:
 
     def test_domain_from_env_when_title_only(self, tmp_path, mocker):
         with clean_env_vars(*ENV_VARS):
-            os.environ["OSW_WIKI_DOMAIN"] = "env-upload.example.com"
+            os.environ["OSW_DOMAIN"] = "env-upload.example.com"
 
             source_file = tmp_path / "env_domain.txt"
             source_file.write_text("data")
@@ -1223,7 +1222,7 @@ def test_live_fallback_fetches_from_wiki(
         )
         try:
             with clean_env_vars(*ENV_VARS):
-                os.environ["OSW_WIKI_DOMAIN"] = wiki_domain
+                os.environ["OSW_DOMAIN"] = wiki_domain
                 os.environ["OSW_CRED_FILEPATH"] = str(cred_filepath)
 
                 with preserve_entity_py_state():