mirror of
https://github.com/qmk/qmk_firmware.git
synced 2024-11-28 14:10:13 +00:00
47 lines
1.3 KiB
Python
47 lines
1.3 KiB
Python
"""Functions that help us work with files and folders.
|
|
"""
|
|
import logging
|
|
import os
|
|
|
|
from qmk.errors import NoSuchKeyboardError
|
|
|
|
def keymap(keyboard):
|
|
"""Locate the correct directory for storing a keymap.
|
|
|
|
Args:
|
|
keyboard
|
|
The name of the keyboard. Example: clueboard/66/rev3
|
|
"""
|
|
for directory in ['.', '..', '../..', '../../..', '../../../..', '../../../../..']:
|
|
basepath = os.path.normpath(os.path.join('keyboards', keyboard, directory, 'keymaps'))
|
|
|
|
if os.path.exists(basepath):
|
|
return basepath
|
|
|
|
logging.error('Could not find keymaps directory!')
|
|
raise NoSuchKeyboardError('Could not find keymaps directory for: %s' % keyboard)
|
|
|
|
|
|
def normpath(path):
|
|
"""Returns the fully resolved absolute path to a file.
|
|
|
|
This function will return the absolute path to a file as seen from the
|
|
directory the script was called from.
|
|
"""
|
|
if path and path[0] == '/':
|
|
return os.path.normpath(path)
|
|
|
|
return os.path.normpath(os.path.join(os.environ['ORIG_CWD'], path))
|
|
|
|
def file_lines(filename):
|
|
""" Return a files content, line by line
|
|
|
|
Args:
|
|
filename: path to the file
|
|
|
|
Returns:
|
|
an list, in which each item is a line of the file
|
|
"""
|
|
with open(filename, "r") as fd:
|
|
return fd.readlines()
|