diff options
author | Erovia <[email protected]> | 2019-10-13 19:07:22 +0200 |
---|---|---|
committer | skullydazed <[email protected]> | 2020-02-15 15:19:03 -0800 |
commit | 26f53d38d932a21be9edfc3d55e585c21050c3a2 (patch) | |
tree | f4d19abe22da554fe9a40928f6fc3eca6163e2ab /lib/python/qmk/path.py | |
parent | f96085af3877a8c42d0767d13d47c239ce08ef0f (diff) | |
download | qmk_firmware-26f53d38d932a21be9edfc3d55e585c21050c3a2.tar.gz qmk_firmware-26f53d38d932a21be9edfc3d55e585c21050c3a2.zip |
Another major refactoring, add documentation
Move all useful functions to the qmk module and use the cli subcommand
as a wrapper around it.
Add both inline comments and documentation.
Diffstat (limited to 'lib/python/qmk/path.py')
-rw-r--r-- | lib/python/qmk/path.py | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/lib/python/qmk/path.py b/lib/python/qmk/path.py index cf087265fb..e7e3ec53fa 100644 --- a/lib/python/qmk/path.py +++ b/lib/python/qmk/path.py @@ -5,6 +5,7 @@ import os from qmk.errors import NoSuchKeyboardError +from bs4 import UnicodeDammit def keymap(keyboard): """Locate the correct directory for storing a keymap. @@ -33,3 +34,20 @@ def normpath(path): return os.path.normpath(path) return os.path.normpath(os.path.join(os.environ['ORIG_CWD'], path)) + +def unicode_text(filename): + """Returns the contents of filename as a UTF-8 string. Tries to DTRT when it comes to encoding. + """ + with open(filename, "rb") as fd: + text = UnicodeDammit(fd.read()) + + if text.contains_replacement_characters: + log_warning("%s: Could not determine file encoding, some characters were replaced." % (filename,)) + + return text.unicode_markup or "" + + +def unicode_lines(filename): + """Returns the contents of filename as a UTF-8 string. Tries to DTRT when it comes to encoding. + """ + return unicode_text(filename).split("\n") |