doc cleanup

Author: mpnowacki-reef

CHANGELOG.md

@@ -25,6 +25,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 * Add `__slots__` and `__eq__` to `FileVersionInfo` for memory usage optimization and ease of testing
 * Add support for SSE-C server-side encryption mode
+* Add support for `XDG_CONFIG_HOME` for determining the location of `SqliteAccountInfo` db file
 
 ### Changed
 * `BasicSyncEncryptionSettingsProvider` supports different settings sets for reading and writing

b2sdk/_v2/__init__.py

@@ -34,7 +34,7 @@
 from b2sdk.account_info.abstract import AbstractAccountInfo
 from b2sdk.account_info.in_memory import InMemoryAccountInfo
 from b2sdk.account_info.sqlite_account_info import SqliteAccountInfo
-from b2sdk.account_info.sqlite_account_info import B2_ACCOUNT_INFO_ENV_VAR, B2_ACCOUNT_INFO_DEFAULT_FILE
+from b2sdk.account_info.sqlite_account_info import B2_ACCOUNT_INFO_ENV_VAR, B2_ACCOUNT_INFO_DEFAULT_FILE, XDG_CONFIG_HOME_ENV_VAR
 from b2sdk.account_info.stub import StubAccountInfo
 from b2sdk.account_info.upload_url_pool import UploadUrlPool
 from b2sdk.account_info.upload_url_pool import UrlPoolAccountInfo

b2sdk/account_info/sqlite_account_info.py

@@ -24,6 +24,7 @@
 
 B2_ACCOUNT_INFO_ENV_VAR = 'B2_ACCOUNT_INFO'
 B2_ACCOUNT_INFO_DEFAULT_FILE = '~/.b2_account_info'
+XDG_CONFIG_HOME_ENV_VAR = 'XDG_CONFIG_HOME'
 
 
 class SqliteAccountInfo(UrlPoolAccountInfo):
@@ -44,13 +45,14 @@ def __init__(self, file_name=None, last_upgrade_to_run=None):
         instead, use ``self.filename`` to get the actual resolved location.
 
         SqliteAccountInfo currently checks locations in the following order:
+
         * ``file_name``, if truthy
-        * ``B2_ACCOUNT_INFO_ENV_VAR``'s value, if set
-        * ``~/.b2_account_info``, if it exists
-        * ``$XDG_CONFIG_HOME/b2/account_info``, if XDG_CONFIG_HOME is set
-        * ``~/.b2_account_info``, as default
+        * ``{B2_ACCOUNT_INFO_ENV_VAR}`` env var's value, if set
+        * ``{B2_ACCOUNT_INFO_DEFAULT_FILE}``, if it exists
+        * ``{XDG_CONFIG_HOME_ENV_VAR}/b2/account_info``, if ``{XDG_CONFIG_HOME_ENV_VAR}`` env var is set
+        * ``{B2_ACCOUNT_INFO_DEFAULT_FILE}``, as default
 
-        If the directory ``$XDG_CONFIG_HOME/b2`` does not exist, it is created.
+        If the directory ``{XDG_CONFIG_HOME_ENV_VAR}/b2`` does not exist (and is needed), it is created.
 
         :param str file_name: The sqlite file to use; overrides the default.
         :param int last_upgrade_to_run: For testing only, override the auto-update on the db.
@@ -63,8 +65,8 @@ def __init__(self, file_name=None, last_upgrade_to_run=None):
             user_account_info_path = os.environ[B2_ACCOUNT_INFO_ENV_VAR]
         elif os.path.exists(os.path.expanduser(B2_ACCOUNT_INFO_DEFAULT_FILE)):
             user_account_info_path = B2_ACCOUNT_INFO_DEFAULT_FILE
-        elif 'XDG_CONFIG_HOME' in os.environ:
-            config_home = os.environ['XDG_CONFIG_HOME']
+        elif XDG_CONFIG_HOME_ENV_VAR in os.environ:
+            config_home = os.environ[XDG_CONFIG_HOME_ENV_VAR]
             user_account_info_path = os.path.join(config_home, 'b2', 'account_info')
             if not os.path.exists(os.path.join(config_home, 'b2')):
                 os.makedirs(os.path.join(config_home, 'b2'), mode=0o755)
@@ -79,6 +81,16 @@ def __init__(self, file_name=None, last_upgrade_to_run=None):
             self._create_tables(conn, last_upgrade_to_run)
         super(SqliteAccountInfo, self).__init__()
 
+    # dirty trick to use parameters in the docstring
+    if getattr(__init__, '__doc__', None):  # don't break when using `python -oo`
+        __init__.__doc__ = __init__.__doc__.format(
+            **dict(
+                B2_ACCOUNT_INFO_ENV_VAR=B2_ACCOUNT_INFO_ENV_VAR,
+                B2_ACCOUNT_INFO_DEFAULT_FILE=B2_ACCOUNT_INFO_DEFAULT_FILE,
+                XDG_CONFIG_HOME_ENV_VAR=XDG_CONFIG_HOME_ENV_VAR,
+            )
+        )
+
     def _validate_database(self, last_upgrade_to_run=None):
         """
         Make sure that the database is openable.  Removes the file if it's not.

b2sdk/v1/account_info.py

@@ -17,6 +17,7 @@
 
 logger = logging.getLogger(__name__)
 
+
 class OldAccountInfoMethods:
     def set_auth_data(
         self,

test/unit/account_info/test_account_info.py

@@ -18,7 +18,7 @@
 
 import pytest
 
-from apiver_deps import AbstractAccountInfo, InMemoryAccountInfo, UploadUrlPool, SqliteAccountInfo, TempDir, B2_ACCOUNT_INFO_ENV_VAR
+from apiver_deps import AbstractAccountInfo, InMemoryAccountInfo, UploadUrlPool, SqliteAccountInfo, TempDir, B2_ACCOUNT_INFO_ENV_VAR, XDG_CONFIG_HOME_ENV_VAR
 from apiver_deps_exception import CorruptAccountInfo, MissingAccountData
 
 from .fixtures import *
@@ -348,11 +348,9 @@ def _make_sqlite_account_info(self, env=None, last_upgrade_to_run=None):
             )
 
     def test_uses_default(self):
-        account_info = self._make_sqlite_account_info(
-            env={
-                'HOME': self.home,
-            }
-        )
+        account_info = self._make_sqlite_account_info(env={
+            'HOME': self.home,
+        })
         actual_path = os.path.abspath(account_info.filename)
         assert os.path.join(self.home, '.b2_account_info') == actual_path
 
@@ -361,7 +359,7 @@ def test_uses_xdg_config_home(self, apiver):
             account_info = self._make_sqlite_account_info(
                 env={
                     'HOME': self.home,
-                    'XDG_CONFIG_HOME': d,
+                    XDG_CONFIG_HOME_ENV_VAR: d,
                 }
             )
             if apiver in ['v0', 'v1']:
@@ -379,7 +377,7 @@ def test_uses_existing_file_and_ignores_xdg(self):
             account_info = self._make_sqlite_account_info(
                 env={
                     'HOME': self.home,
-                    'XDG_CONFIG_HOME': d,
+                    XDG_CONFIG_HOME_ENV_VAR: d,
                 }
             )
             assert not os.path.exists(os.path.join(d, 'b2'))
@@ -391,7 +389,7 @@ def test_account_info_env_var_overrides_xdg_config_home(self):
             account_info = self._make_sqlite_account_info(
                 env={
                     'HOME': self.home,
-                    'XDG_CONFIG_HOME': d,
+                    XDG_CONFIG_HOME_ENV_VAR: d,
                     B2_ACCOUNT_INFO_ENV_VAR: os.path.join(d, 'b2_account_info'),
                 }
             )