import argparse import fnmatch import json import os from collections import defaultdict from pathlib import PosixPath, PurePosixPath class BuildrootPath(PurePosixPath): """ This path represents a path in a buildroot. When absolute, it is "relative" to a buildroot. E.g. /usr/lib means %{buildroot}/usr/lib The object carries no buildroot information. """ @staticmethod def from_real(realpath, *, root): """ For a given real disk path, return a BuildrootPath in the given root. For example:: >>> BuildrootPath.from_real(PosixPath('/tmp/buildroot/foo'), root=PosixPath('/tmp/buildroot')) BuildrootPath('/foo') """ return BuildrootPath("/") / realpath.relative_to(root) def to_real(self, root): """ Return a real PosixPath in the given root For example:: >>> BuildrootPath('/foo').to_real(PosixPath('/tmp/buildroot')) PosixPath('/tmp/buildroot/foo') """ return root / self.relative_to("/") def normpath(self): """ Normalize all the potential /../ parts of the path without touching real files. PurePaths don't have .resolve(). Paths have .resolve() but it touches real files. This is an alternative. It assumes there are no symbolic links. Example: >>> BuildrootPath('/usr/lib/python/../pypy').normpath() BuildrootPath('/usr/lib/pypy') """ return type(self)(os.path.normpath(self)) def pycached(script, python_version): """ For a script BuildrootPath, return a list with that path and its bytecode glob. Like the %pycached macro. The glob is represented as a BuildrootPath. Examples: >>> pycached(BuildrootPath('/whatever/bar.py'), '3.8') [BuildrootPath('/whatever/bar.py'), BuildrootPath('/whatever/__pycache__/bar.cpython-38{,.opt-?}.pyc')] >>> pycached(BuildrootPath('/opt/python3.10/foo.py'), '3.10') [BuildrootPath('/opt/python3.10/foo.py'), BuildrootPath('/opt/python3.10/__pycache__/foo.cpython-310{,.opt-?}.pyc')] """ assert script.suffix == ".py" pyver = "".join(python_version.split(".")[:2]) pycname = f"{script.stem}.cpython-{pyver}{{,.opt-?}}.pyc" pyc = script.parent / "__pycache__" / pycname return [script, pyc] def add_file_to_module(paths, module_name, module_type, *files): """ Helper procedure, adds given files to the module_name of a given module_type """ for module in paths["modules"][module_name]: if module["type"] == module_type: if files[0] not in module["files"]: module["files"].extend(files) break else: paths["modules"][module_name].append( {"type": module_type, "files": list(files)} ) def add_lang_to_module(paths, module_name, path): """ Helper procedure, divides lang files by language and adds them to the module_name Returns True if the language code detection was successful """ for i, parent in enumerate(path.parents): if i > 0 and parent.name == 'locale': lang_country_code = path.parents[i-1].name break else: return False # convert potential en_US to plain en lang_code = lang_country_code.partition('_')[0] if module_name not in paths["lang"]: paths["lang"].update({module_name: defaultdict(list)}) paths["lang"][module_name][lang_code].append(path) return True def classify_paths( record_path, parsed_record_content, sitedirs, python_version ): """ For each BuildrootPath in parsed_record_content classify it to a dict structure that allows to filter the files for the %files section easier. For the dict structure, look at the beginning of this function's code. Each "module" is a dict with "type" ("package", "script", "extension") and "files". """ distinfo = record_path.parent paths = { "metadata": { "files": [], # regular %file entries with dist-info content "dirs": [distinfo], # %dir %file entries with dist-info directory "docs": [], # to be used once there is upstream way to recognize READMEs "licenses": [], # to be used once there is upstream way to recognize LICENSEs }, "lang": {}, # %lang entries: [module_name or None][language_code] lists of .mo files "modules": defaultdict(list), # each importable module (directory, .py, .so) "other": {"files": []}, # regular %file entries we could not parse :( } # In RECORDs generated by pip, there are no directories, only files. # The example RECORD from PEP 376 does not contain directories either. # Hence, we'll only assume files, but TODO get it officially documented. for path in parsed_record_content: if path.suffix == ".pyc": # we handle bytecode separately continue if path.parent == distinfo: if path.name in ("RECORD", "REQUESTED"): # RECORD and REQUESTED files are removed in %pyproject_install # See PEP 627 continue # TODO is this a license/documentation? paths["metadata"]["files"].append(path) continue for sitedir in sitedirs: if sitedir in path.parents: if path.parent == sitedir: if path.suffix == ".so": # extension modules can have 2 suffixes name = BuildrootPath(path.stem).stem add_file_to_module(paths, name, "extension", path) elif path.suffix == ".py": name = path.stem add_file_to_module( paths, name, "script", *pycached(path, python_version) ) else: paths["other"]["files"].append(path) else: # this file is inside a dir, we classify that dir index = path.parents.index(sitedir) module_dir = path.parents[index - 1] add_file_to_module(paths, module_dir.name, "package", module_dir) if path.suffix == ".mo": add_lang_to_module(paths, module_dir.name, path) break else: if path.suffix == ".mo": add_lang_to_module(paths, None, path) or paths["other"]["files"].append(path) else: paths["other"]["files"].append(path) return paths def generate_file_list(paths_dict, module_globs, include_others=False): """ This function takes the classified paths_dict and turns it into lines for the %files section. Returns list with text lines, no Path objects. Only includes files from modules that match module_globs, metadata and optionaly all other files. It asserts that all globs match at least one module, raises ValueError otherwise. Multiple globs matching identical module(s) are OK. """ files = set() if include_others: files.update(f"{p}" for p in paths_dict["other"]["files"]) try: for lang_code in paths_dict["lang"][None]: files.update(f"%lang({lang_code}) {path}" for path in paths_dict["lang"][None][lang_code]) except KeyError: pass files.update(f"{p}" for p in paths_dict["metadata"]["files"]) for macro in "dir", "doc", "license": files.update(f"%{macro} {p}" for p in paths_dict["metadata"][f"{macro}s"]) modules = paths_dict["modules"] done_modules = set() done_globs = set() for glob in module_globs: for name in modules: if fnmatch.fnmatchcase(name, glob): if name not in done_modules: try: for lang_code in paths_dict["lang"][name]: files.update(f"%lang({lang_code}) {path}" for path in paths_dict["lang"][name][lang_code]) except KeyError: pass for module in modules[name]: if module["type"] == "package": files.update(f"{p}/" for p in module["files"]) else: files.update(f"{p}" for p in module["files"]) done_modules.add(name) done_globs.add(glob) missed = module_globs - done_globs if missed: missed_text = ", ".join(sorted(missed)) raise ValueError(f"Globs did not match any module: {missed_text}") return sorted(files) def parse_varargs(varargs): """ Parse varargs from the %pyproject_save_files macro Arguments starting with + are treated as a flags, everything else is a glob Returns as set of globs, boolean flag whether to include all the other files Raises ValueError for unknown flags and globs with dots (namespace packages). Good examples: >>> parse_varargs(['*']) ({'*'}, False) >>> mods, auto = parse_varargs(['requests*', 'kerberos', '+auto']) >>> auto True >>> sorted(mods) ['kerberos', 'requests*'] >>> mods, auto = parse_varargs(['tldr', 'tensorf*']) >>> auto False >>> sorted(mods) ['tensorf*', 'tldr'] >>> parse_varargs(['+auto']) (set(), True) Bad examples: >>> parse_varargs(['+kinkdir']) Traceback (most recent call last): ... ValueError: Invalid argument: +kinkdir >>> parse_varargs(['good', '+bad', '*ugly*']) Traceback (most recent call last): ... ValueError: Invalid argument: +bad >>> parse_varargs(['+bad', 'my.bad']) Traceback (most recent call last): ... ValueError: Invalid argument: +bad >>> parse_varargs(['mod', 'mod.*']) Traceback (most recent call last): ... ValueError: Attempted to use a namespaced package with dot in the glob: mod.*. ... >>> parse_varargs(['my.bad', '+bad']) Traceback (most recent call last): ... ValueError: Attempted to use a namespaced package with dot in the glob: my.bad. ... """ include_auto = False globs = set() for arg in varargs: if arg.startswith("+"): if arg == "+auto": include_auto = True else: raise ValueError(f"Invalid argument: {arg}") elif "." in arg: top, *_ = arg.partition(".") msg = ( f"Attempted to use a namespaced package with dot in the glob: {arg}. " f"That is not (yet) supported. Use {top} instead and/or file a Bugzilla explaining your use case." ) raise ValueError(msg) else: globs.add(arg) return globs, include_auto def load_parsed_record(pyproject_record): parsed_record = {} with open(pyproject_record) as pyproject_record_file: content = json.load(pyproject_record_file) if len(content) > 1: raise FileExistsError("%pyproject install has found more than one *.dist-info/RECORD file. " "Currently, %pyproject_save_files supports only one wheel → one file list mapping. " "Feel free to open a bugzilla for pyproject-rpm-macros and describe your usecase.") # Redefine strings stored in JSON to BuildRootPaths for record_path, files in content.items(): parsed_record[BuildrootPath(record_path)] = [BuildrootPath(f) for f in files] return parsed_record def pyproject_save_files(buildroot, sitelib, sitearch, python_version, pyproject_record, varargs): """ Takes arguments from the %{pyproject_save_files} macro Returns list of paths for the %files section """ # On 32 bit architectures, sitelib equals to sitearch # This saves us browsing one directory twice sitedirs = sorted({sitelib, sitearch}) globs, include_auto = parse_varargs(varargs) parsed_records = load_parsed_record(pyproject_record) final_file_list = [] for record_path, files in parsed_records.items(): paths_dict = classify_paths( record_path, files, sitedirs, python_version ) final_file_list.extend( generate_file_list(paths_dict, globs, include_auto) ) return final_file_list def main(cli_args): file_section = pyproject_save_files( cli_args.buildroot, cli_args.sitelib, cli_args.sitearch, cli_args.python_version, cli_args.pyproject_record, cli_args.varargs, ) cli_args.output.write_text("\n".join(file_section) + "\n", encoding="utf-8") def argparser(): parser = argparse.ArgumentParser() r = parser.add_argument_group("required arguments") r.add_argument("--output", type=PosixPath, required=True) r.add_argument("--buildroot", type=PosixPath, required=True) r.add_argument("--sitelib", type=BuildrootPath, required=True) r.add_argument("--sitearch", type=BuildrootPath, required=True) r.add_argument("--python-version", type=str, required=True) r.add_argument("--pyproject-record", type=PosixPath, required=True) parser.add_argument("varargs", nargs="+") return parser if __name__ == "__main__": cli_args = argparser().parse_args() main(cli_args)