mirrors/opensteno_qmk
1
0
Fork 0
mirror of https://github.com/openstenoproject/qmk synced 2024-11-13 03:54:42 +00:00
Code Issues Projects Releases Packages Wiki Activity
opensteno_qmk/lib/python/qmk/makefile.py

84 lines
2.4 KiB
Python
Raw Normal View History

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.
2019-10-13 17:07:22 +00:00
""" Functions for working with Makefiles
"""
Code cleanup, use pathlib, use pytest keyboard Clean up checks and logics that are unnecessary due to MILC updates. Use pathlib instead of os.path for readability. Use the 'pytest' keyboard for the tests. Add community layout for 'handwired/onekey/pytest' so we can test community layouts.
2020-01-12 11:36:41 +00:00
from pathlib import Path
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.
2019-10-13 17:07:22 +00:00
from qmk.errors import NoSuchKeyboardError
Fix commandline parsing and flake8 findings, rebase Fixed commandline and config parsing. Thx @xplusplus. Rebased on master and fixed merge conflicts.
2020-01-07 20:54:21 +00:00
Major rework, no regex/globbing, more walking Instead of using regexes and globbing to find the rules.mk and keymap.c files, walk the directory tree to find them. Also, do away with the concept of revision.
2019-10-28 08:23:06 +00:00
def parse_rules_mk_file(file, rules_mk=None):
"""Turn a rules.mk file into a dictionary.
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.
2019-10-13 17:07:22 +00:00
Args:
Major rework, no regex/globbing, more walking Instead of using regexes and globbing to find the rules.mk and keymap.c files, walk the directory tree to find them. Also, do away with the concept of revision.
2019-10-28 08:23:06 +00:00
file: path to the rules.mk file
rules_mk: already parsed rules.mk the new file should be merged with
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.
2019-10-13 17:07:22 +00:00
Returns:
a dictionary with the file's content
"""
Major rework, no regex/globbing, more walking Instead of using regexes and globbing to find the rules.mk and keymap.c files, walk the directory tree to find them. Also, do away with the concept of revision.
2019-10-28 08:23:06 +00:00
if not rules_mk:
rules_mk = {}
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.
2019-10-13 17:07:22 +00:00
Code cleanup, use pathlib, use pytest keyboard Clean up checks and logics that are unnecessary due to MILC updates. Use pathlib instead of os.path for readability. Use the 'pytest' keyboard for the tests. Add community layout for 'handwired/onekey/pytest' so we can test community layouts.
2020-01-12 11:36:41 +00:00
file = Path(file)
if file.exists():
rules_mk_lines = file.read_text().split("\n")
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.
2019-10-13 17:07:22 +00:00
Major rework, no regex/globbing, more walking Instead of using regexes and globbing to find the rules.mk and keymap.c files, walk the directory tree to find them. Also, do away with the concept of revision.
2019-10-28 08:23:06 +00:00
for line in rules_mk_lines:
# Filter out comments
if line.strip().startswith("#"):
continue
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.
2019-10-13 17:07:22 +00:00
Major rework, no regex/globbing, more walking Instead of using regexes and globbing to find the rules.mk and keymap.c files, walk the directory tree to find them. Also, do away with the concept of revision.
2019-10-28 08:23:06 +00:00
# Strip in-line comments
if '#' in line:
line = line[:line.index('#')].strip()
if '=' in line:
# Append
if '+=' in line:
key, value = line.split('+=', 1)
if key.strip() not in rules_mk:
rules_mk[key.strip()] = value.strip()
else:
rules_mk[key.strip()] += ' ' + value.strip()
# Set if absent
elif "?=" in line:
key, value = line.split('?=', 1)
if key.strip() not in rules_mk:
rules_mk[key.strip()] = value.strip()
else:
if ":=" in line:
Fix commandline parsing and flake8 findings, rebase Fixed commandline and config parsing. Thx @xplusplus. Rebased on master and fixed merge conflicts.
2020-01-07 20:54:21 +00:00
line.replace(":", "")
Major rework, no regex/globbing, more walking Instead of using regexes and globbing to find the rules.mk and keymap.c files, walk the directory tree to find them. Also, do away with the concept of revision.
2019-10-28 08:23:06 +00:00
key, value = line.split('=', 1)
rules_mk[key.strip()] = value.strip()
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.
2019-10-13 17:07:22 +00:00
Major rework, no regex/globbing, more walking Instead of using regexes and globbing to find the rules.mk and keymap.c files, walk the directory tree to find them. Also, do away with the concept of revision.
2019-10-28 08:23:06 +00:00
return rules_mk
Fix commandline parsing and flake8 findings, rebase Fixed commandline and config parsing. Thx @xplusplus. Rebased on master and fixed merge conflicts.
2020-01-07 20:54:21 +00:00
Major rework, no regex/globbing, more walking Instead of using regexes and globbing to find the rules.mk and keymap.c files, walk the directory tree to find them. Also, do away with the concept of revision.
2019-10-28 08:23:06 +00:00
def get_rules_mk(keyboard):
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.
2019-10-13 17:07:22 +00:00
""" Get a rules.mk for a keyboard
Args:
keyboard: name of the keyboard
Major rework, no regex/globbing, more walking Instead of using regexes and globbing to find the rules.mk and keymap.c files, walk the directory tree to find them. Also, do away with the concept of revision.
2019-10-28 08:23:06 +00:00
Raises:
NoSuchKeyboardError: when the keyboard does not exists
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.
2019-10-13 17:07:22 +00:00
Returns:
a dictionary with the content of the rules.mk file
"""
Major rework, no regex/globbing, more walking Instead of using regexes and globbing to find the rules.mk and keymap.c files, walk the directory tree to find them. Also, do away with the concept of revision.
2019-10-28 08:23:06 +00:00
# Start with qmk_firmware/keyboards
Code cleanup, use pathlib, use pytest keyboard Clean up checks and logics that are unnecessary due to MILC updates. Use pathlib instead of os.path for readability. Use the 'pytest' keyboard for the tests. Add community layout for 'handwired/onekey/pytest' so we can test community layouts.
2020-01-12 11:36:41 +00:00
kb_path = Path.cwd() / "keyboards"
Major rework, no regex/globbing, more walking Instead of using regexes and globbing to find the rules.mk and keymap.c files, walk the directory tree to find them. Also, do away with the concept of revision.
2019-10-28 08:23:06 +00:00
# walk down the directory tree
# and collect all rules.mk files
Code cleanup, use pathlib, use pytest keyboard Clean up checks and logics that are unnecessary due to MILC updates. Use pathlib instead of os.path for readability. Use the 'pytest' keyboard for the tests. Add community layout for 'handwired/onekey/pytest' so we can test community layouts.
2020-01-12 11:36:41 +00:00
kb_dir = kb_path / keyboard
if kb_dir.exists():
Major rework, no regex/globbing, more walking Instead of using regexes and globbing to find the rules.mk and keymap.c files, walk the directory tree to find them. Also, do away with the concept of revision.
2019-10-28 08:23:06 +00:00
rules_mk = dict()
Code cleanup, use pathlib, use pytest keyboard Clean up checks and logics that are unnecessary due to MILC updates. Use pathlib instead of os.path for readability. Use the 'pytest' keyboard for the tests. Add community layout for 'handwired/onekey/pytest' so we can test community layouts.
2020-01-12 11:36:41 +00:00
for directory in Path(keyboard).parts:
kb_path = kb_path / directory
rules_mk_path = kb_path / "rules.mk"
if rules_mk_path.exists():
Major rework, no regex/globbing, more walking Instead of using regexes and globbing to find the rules.mk and keymap.c files, walk the directory tree to find them. Also, do away with the concept of revision.
2019-10-28 08:23:06 +00:00
rules_mk = parse_rules_mk_file(rules_mk_path, rules_mk)
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.
2019-10-13 17:07:22 +00:00
else:
raise NoSuchKeyboardError("The requested keyboard and/or revision does not exist.")
return rules_mk
Reference in a new issue Copy permalink