-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
221 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,2 @@ | ||
recursive-include ovos_utils/res * | ||
recursive-include ovos_utils/requirements * | ||
recursive-include requirements * |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,174 @@ | ||
# Copyright © 2016-2021 Scott Stevenson <scott@stevenson.io> | ||
# | ||
# Permission to use, copy, modify, and/or distribute this software for | ||
# any purpose with or without fee is hereby granted, provided that the | ||
# above copyright notice and this permission notice appear in all | ||
# copies. | ||
# | ||
# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL | ||
# WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED | ||
# WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE | ||
# AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL | ||
# DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR | ||
# PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER | ||
# TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR | ||
# PERFORMANCE OF THIS SOFTWARE. | ||
|
||
"""XDG Base Directory Specification variables. | ||
xdg_cache_home(), xdg_config_home(), xdg_data_home(), and xdg_state_home() | ||
return pathlib.Path objects containing the value of the environment variable | ||
named XDG_CACHE_HOME, XDG_CONFIG_HOME, XDG_DATA_HOME, and XDG_STATE_HOME | ||
respectively, or the default defined in the specification if the environment | ||
variable is unset, empty, or contains a relative path rather than absolute | ||
path. | ||
xdg_config_dirs() and xdg_data_dirs() return a list of pathlib.Path | ||
objects containing the value, split on colons, of the environment | ||
variable named XDG_CONFIG_DIRS and XDG_DATA_DIRS respectively, or the | ||
default defined in the specification if the environment variable is | ||
unset or empty. Relative paths are ignored, as per the specification. | ||
xdg_runtime_dir() returns a pathlib.Path object containing the value of | ||
the XDG_RUNTIME_DIR environment variable, or None if the environment | ||
variable is not set, or contains a relative path rather than absolute path. | ||
""" | ||
|
||
# pylint: disable=fixme | ||
|
||
import os | ||
from pathlib import Path | ||
from typing import List, Optional | ||
|
||
__all__ = [ | ||
"xdg_cache_home", | ||
"xdg_config_dirs", | ||
"xdg_config_home", | ||
"xdg_data_dirs", | ||
"xdg_data_home", | ||
"xdg_runtime_dir", | ||
"xdg_state_home", | ||
"XDG_CACHE_HOME", | ||
"XDG_CONFIG_DIRS", | ||
"XDG_CONFIG_HOME", | ||
"XDG_DATA_DIRS", | ||
"XDG_DATA_HOME", | ||
"XDG_RUNTIME_DIR", | ||
] | ||
|
||
|
||
def _path_from_env(variable: str, default: Path) -> Path: | ||
"""Read an environment variable as a path. | ||
The environment variable with the specified name is read, and its | ||
value returned as a path. If the environment variable is not set, is | ||
set to the empty string, or is set to a relative rather than | ||
absolute path, the default value is returned. | ||
Parameters | ||
---------- | ||
variable : str | ||
Name of the environment variable. | ||
default : Path | ||
Default value. | ||
Returns | ||
------- | ||
Path | ||
Value from environment or default. | ||
""" | ||
# TODO(srstevenson): Use assignment expression in Python 3.8. | ||
value = os.environ.get(variable) | ||
if value and os.path.isabs(value): | ||
return Path(value) | ||
return default | ||
|
||
|
||
def _paths_from_env(variable: str, default: List[Path]) -> List[Path]: | ||
"""Read an environment variable as a list of paths. | ||
The environment variable with the specified name is read, and its | ||
value split on colons and returned as a list of paths. If the | ||
environment variable is not set, or set to the empty string, the | ||
default value is returned. Relative paths are ignored, as per the | ||
specification. | ||
Parameters | ||
---------- | ||
variable : str | ||
Name of the environment variable. | ||
default : List[Path] | ||
Default value. | ||
Returns | ||
------- | ||
List[Path] | ||
Value from environment or default. | ||
""" | ||
# TODO(srstevenson): Use assignment expression in Python 3.8. | ||
value = os.environ.get(variable) | ||
if value: | ||
paths = [ | ||
Path(path) for path in value.split(":") if os.path.isabs(path) | ||
] | ||
if paths: | ||
return paths | ||
return default | ||
|
||
|
||
def xdg_cache_home() -> Path: | ||
"""Return a Path corresponding to XDG_CACHE_HOME.""" | ||
return _path_from_env("XDG_CACHE_HOME", Path.home() / ".cache") | ||
|
||
|
||
def xdg_config_dirs() -> List[Path]: | ||
"""Return a list of Paths corresponding to XDG_CONFIG_DIRS.""" | ||
return _paths_from_env("XDG_CONFIG_DIRS", [Path("/etc/xdg")]) | ||
|
||
|
||
def xdg_config_home() -> Path: | ||
"""Return a Path corresponding to XDG_CONFIG_HOME.""" | ||
return _path_from_env("XDG_CONFIG_HOME", Path.home() / ".config") | ||
|
||
|
||
def xdg_data_dirs() -> List[Path]: | ||
"""Return a list of Paths corresponding to XDG_DATA_DIRS.""" | ||
return _paths_from_env( | ||
"XDG_DATA_DIRS", | ||
[Path(path) for path in "/usr/local/share/:/usr/share/".split(":")], | ||
) | ||
|
||
|
||
def xdg_data_home() -> Path: | ||
"""Return a Path corresponding to XDG_DATA_HOME.""" | ||
return _path_from_env("XDG_DATA_HOME", Path.home() / ".local" / "share") | ||
|
||
|
||
def xdg_runtime_dir() -> Optional[Path]: | ||
"""Return a Path corresponding to XDG_RUNTIME_DIR. | ||
If the XDG_RUNTIME_DIR environment variable is not set, None will be | ||
returned as per the specification. | ||
""" | ||
value = os.getenv("XDG_RUNTIME_DIR") | ||
if value and os.path.isabs(value): | ||
return Path(value) | ||
return None | ||
|
||
|
||
def xdg_state_home() -> Path: | ||
"""Return a Path corresponding to XDG_STATE_HOME.""" | ||
return _path_from_env("XDG_STATE_HOME", Path.home() / ".local" / "state") | ||
|
||
|
||
# The following variables are deprecated, but remain for backward compatibility. | ||
XDG_CACHE_HOME = xdg_cache_home() | ||
XDG_CONFIG_DIRS = xdg_config_dirs() | ||
XDG_CONFIG_HOME = xdg_config_home() | ||
XDG_DATA_DIRS = xdg_data_dirs() | ||
XDG_DATA_HOME = xdg_data_home() | ||
XDG_RUNTIME_DIR = xdg_runtime_dir() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,6 @@ | ||
mycroft-messagebus-client~=0.9.1,!=0.9.2,!=0.9.3 | ||
pexpect~=4.8 | ||
requests~=2.26 | ||
json_database~=0.5 | ||
json_database~=0.7 | ||
kthread~=0.2 | ||
pyxdg~=0.26 | ||
PyYAML~=5.4 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters