nix-community/dream2nix
1
1
Fork 0
mirror of https://github.com/nix-community/dream2nix.git synced 2024-11-24 01:24:57 +03:00
Code Issues Projects Releases Wiki Activity

override: unify overriding across modules

Browse Source 
Add options `overrides.${name}` and `overrideAll` to all language modules that manage a dependency tree.

This is done in a backward compatible fashion. Old options for overriding dependencies continue working, though those are not displayed in the manual anymore.

For the following modules the manual now suggest using the new unified override options:
- for pip: use `pip.overrides` and `pip.overrideAll` instead of  `pip.drvs`
- for nodejs-granular-v3: use `nodejs-granular-v3.overrides` and `nodejs-granular-v3.overrideAll` instead of `nodejs-granular-v3.deps`
- `php-granular`: use `php-granular.override` and `php-granular.overrideAll` instead of `php-granular.deps`
This commit is contained in:
DavHau 2024-03-13 14:13:39 +07:00
parent cd782df677
commit b727a07775
14 changed files with 291 additions and 172 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
CHANGELOG.md Normal file
View File

@ -0,0 +1,13 @@
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
## [Unreleased]
### Added
#### Unified override interface across languages
New options `overrides.${name}` and `overrideAll` for all language modules that manage a dependency tree.

2
examples/packages/languages/python-local-development-multiple-packages/default.nix
View File

@ -38,6 +38,6 @@ in {
"${config.paths.package}/subpkg1"
"${config.paths.package}/subpkg2"
];
drvs.subpkg2 = buildWithSetuptools;
overrides.subpkg2 = buildWithSetuptools;
};
}

2
examples/packages/languages/python-packaging-apache-airflow/default.nix
View File

@ -53,7 +53,7 @@ in {
"setuptools-scm"
];
drvs = {
overrides = {
# We include fixes from nixpkgs for pendulum, but keep
# our dependencies to avoid version conflicts
pendulum = {

2
examples/packages/languages/python-packaging-odoo/default.nix
View File

@ -45,7 +45,7 @@ in {
nativeBuildInputs = [config.deps.postgresql];
# fix some builds via package-specific overrides
drvs = {
overrides = {
psycopg2 = {
imports = [
dream2nix.modules.dream2nix.nixpkgs-overrides

13
lib/internal/mkSubmodule.nix Normal file
View File

@ -0,0 +1,13 @@
{
lib,
specialArgs,
...
}: module:
lib.mkOption {
type = lib.types.submoduleWith {
inherit specialArgs;
modules = [
module
];
};
}

7
modules/dream2nix/nodejs-granular-v3/default.nix
View File

@ -49,11 +49,6 @@
source = pdefs.${name}.${version}.source;
};
nameVersionPair = name: version: {
name = name;
version = version;
};
# name: version: -> [ {name=; version=; } ]
getDependencies = pname: version:
l.filter
@ -87,6 +82,8 @@
imports = [
(commonModule name version)
(depsModule name version)
cfg.overrideAll
(cfg.overrides.${name} or {})
];
})
versions

74
modules/dream2nix/nodejs-granular-v3/interface.nix
View File

@ -3,44 +3,58 @@
lib,
dream2nix,
packageSets,
specialArgs,
...
}: let
l = lib // builtins;
t = l.types;
cfg = config.nodejs-granular-v3;
mkSubmodule = import ../../../lib/internal/mkSubmodule.nix {inherit lib specialArgs;};
in {
options.nodejs-granular-v3 = l.mapAttrs (_: l.mkOption) {
buildScript = {
type = t.nullOr (t.oneOf [t.str t.path t.package]);
description = ''
A command or script to execute instead of `npm run build`.
Is only executed if `runBuild = true`.
'';
};
installMethod = {
type = t.enum [
"symlink"
"copy"
options.nodejs-granular-v3 = mkSubmodule {
imports = [
../overrides
];
config.overrideType = {
imports = [
dream2nix.modules.dream2nix.mkDerivation
];
description = ''
Strategy to use for populating ./node_modules.
Symlinking is quicker, but often introduces compatibility issues with bundlers like webpack and other build tools.
Copying is slow, but more reliable;
'';
};
runBuild = {
type = t.bool;
description = ''
Whether to run a package's build script (aka. `npm run build`)
'';
};
deps = {
type = t.attrsOf (t.attrsOf (t.submodule {
imports = [
dream2nix.modules.dream2nix.core
dream2nix.modules.dream2nix.mkDerivation
options = l.mapAttrs (_: l.mkOption) {
buildScript = {
type = t.nullOr (t.oneOf [t.str t.path t.package]);
description = ''
A command or script to execute instead of `npm run build`.
Is only executed if `runBuild = true`.
'';
};
installMethod = {
type = t.enum [
"symlink"
"copy"
];
_module.args = {inherit dream2nix packageSets;};
}));
description = ''
Strategy to use for populating ./node_modules.
Symlinking is quicker, but often introduces compatibility issues with bundlers like webpack and other build tools.
Copying is slow, but more reliable;
'';
};
runBuild = {
type = t.bool;
description = ''
Whether to run a package's build script (aka. `npm run build`)
'';
};
deps = {
internal = true;
# hack because internal doesn't propagate to submodule options
visible = "shallow";
type = t.attrsOf (t.attrsOf (t.submodule {
imports = [
cfg.overrideType
];
}));
};
};
};
}

5
modules/dream2nix/overrides/default.nix Normal file
View File

@ -0,0 +1,5 @@
{
imports = [
./interface.nix
];
}

45
modules/dream2nix/overrides/interface.nix Normal file
View File

@ -0,0 +1,45 @@
{
lib,
specialArgs,
config,
...
}: let
t = lib.types;
staticModules = [
{_module.args = specialArgs;}
config.overrideType
];
in {
options = {
overrideAll = lib.mkOption {
type = t.deferredModuleWith {inherit staticModules;};
description = ''
Overrides applied on all dependencies.
'';
default = {};
example = {
mkDerivation.doCheck = false;
};
};
overrides = lib.mkOption {
type = t.attrsOf (t.deferredModuleWith {inherit staticModules;});
description = ''
Overrides applied only on dependencies matching the specified name.
'';
default = {};
example = {
hello.mkDerivation.postPatch = ''
substituteInPlace Makefile --replace /usr/local /usr
'';
};
};
## INTERNAL
overrideType = lib.mkOption {
type = t.deferredModule;
default = {};
internal = true;
};
};
}

10
modules/dream2nix/php-granular/default.nix
View File

@ -165,8 +165,8 @@
if version == "unknown"
then "0.0.0"
else version;
module = {config, ...}: {
in
{config, ...}: {
imports = [
dream2nix.modules.dream2nix.mkDerivation
];
@ -289,8 +289,6 @@
'';
};
};
in
module;
in {
imports = [
./interface.nix
@ -308,7 +306,9 @@ in {
imports = [
./interface.nix
(commonModule name version)
dream2nix.modules.dream2nix.mkDerivation
cfg.overrideType
cfg.overrideAll
(cfg.overrides.${name} or {})
];
inherit name version;
}

43
modules/dream2nix/php-granular/interface.nix
View File

@ -1,29 +1,40 @@
{
config,
dream2nix,
packageSets,
lib,
packageSets,
specialArgs,
...
}: let
l = lib // builtins;
t = l.types;
cfg = config.php-granular;
mkSubmodule = import ../../../lib/internal/mkSubmodule.nix {inherit lib specialArgs;};
in {
options.php-granular = l.mapAttrs (_: l.mkOption) {
deps = {
type = t.lazyAttrsOf (t.lazyAttrsOf (t.submodule {
imports = [
dream2nix.modules.dream2nix.core
# TODO: fix this
# putting mkDerivation here leads to an error when generating docs:
# The option `php-granular.deps.<name>.<name>.version' is used but not defined.
# dream2nix.modules.dream2nix.mkDerivation
];
_module.args = {inherit dream2nix packageSets;};
}));
options.php-granular = mkSubmodule {
imports = [
../overrides
];
config.overrideType = {
imports = [
dream2nix.modules.dream2nix.mkDerivation
];
};
composerInstallFlags = {
type = t.listOf t.str;
default = [];
options = l.mapAttrs (_: l.mkOption) {
deps = {
internal = true;
visible = "shallow";
type = t.lazyAttrsOf (t.lazyAttrsOf (t.submodule {
imports = [
dream2nix.modules.dream2nix.core
cfg.overrideType
];
}));
};
composerInstallFlags = {
type = t.listOf t.str;
default = [];
};
};
};
}

2
modules/dream2nix/pip/default.nix
View File

@ -33,6 +33,8 @@
imports = [
commonModule
dependencyModule
cfg.overrideAll
(cfg.overrides.${name} or {})
# include community overrides
(dream2nix.overrides.python.${name} or {})
];

243
modules/dream2nix/pip/interface.nix
View File

@ -3,130 +3,147 @@
lib,
dream2nix,
packageSets,
specialArgs,
...
}: let
l = lib // builtins;
t = l.types;
mkSubmodule = import ../../../lib/internal/mkSubmodule.nix {inherit lib specialArgs;};
in {
options.pip = {
# internal options to pass data between pip-hotfixes and pip
targets = l.mkOption {
type = t.raw;
internal = true;
description = "the targets of the lock file to build";
};
rootDependencies = l.mkOption {
type = t.attrsOf t.bool;
internal = true;
description = "the names of the selected top-level dependencies";
options.pip = mkSubmodule {
imports = [
../overrides
];
config.overrideType = {
imports = [
dream2nix.modules.dream2nix.buildPythonPackage
];
};
# user interface
env = l.mkOption {
type = t.attrsOf t.str;
default = {};
description = ''
environment variables exported while locking
'';
example = lib.literalExpression ''
{
PIP_FIND_LINKS = "''${config.deps.setuptools.dist}";
}
'';
};
pypiSnapshotDate = l.mkOption {
type = t.nullOr t.str;
description = ''
maximum release date for packages
Choose any date from the past.
'';
example = "2023-01-01";
default = null;
};
pipFlags = l.mkOption {
type = t.listOf t.str;
description = ''
list of flags for pip install
'';
default = [];
};
pipVersion = l.mkOption {
type = t.str;
description = ''
pip version to use to generate the report
'';
default = "23.1";
};
requirementsList = l.mkOption {
type = t.listOf t.str;
default = [];
description = ''
list of strings of requirements.txt entries
'';
};
requirementsFiles = l.mkOption {
type = t.listOf t.str;
default = [];
description = ''
list of requirements.txt files
'';
};
buildDependencies = l.mkOption {
type = t.attrsOf t.bool;
default = {
cython = true;
flit-core = true;
flit-scm = true;
hatch-fancy-pypi-readme = true;
hatch-nodejs-version = true;
hatch-vcs = true;
hatchling = true;
pbr = true;
pdm-pep517 = true;
poetry-core = true;
poetry-dynamic-versioning = true;
setuptools = true;
setuptools-odoo = true;
setuptools-scm = true;
versioneer = true;
wheel = true;
options = {
# internal options to pass data between pip-hotfixes and pip
targets = l.mkOption {
type = t.raw;
internal = true;
description = "the targets of the lock file to build";
};
rootDependencies = l.mkOption {
type = t.attrsOf t.bool;
internal = true;
description = "the names of the selected top-level dependencies";
};
description = ''
python packages to be added only as buildInputs.
These should be somehow installable from `requirementsList` or
`requirementsFiles` too; listing them here doesn't do that automatically.
'';
example = lib.literalExpression ''
{
setuptools-scm = false; # To disable the default
easy_install = true; # To select easy_install as a buildInput
}
'';
};
buildExtras = l.mkOption {
type = t.listOf t.str;
default = [];
description = ''
list of python "extras" to build with. This can be a subset of the
extras in your lock file.
'';
};
# user interface
env = l.mkOption {
type = t.attrsOf t.str;
default = {};
description = ''
environment variables exported while locking
'';
example = lib.literalExpression ''
{
PIP_FIND_LINKS = "''${config.deps.setuptools.dist}";
}
'';
};
pypiSnapshotDate = l.mkOption {
type = t.nullOr t.str;
description = ''
maximum release date for packages
Choose any date from the past.
'';
example = "2023-01-01";
default = null;
};
pipFlags = l.mkOption {
type = t.listOf t.str;
description = ''
list of flags for pip install
'';
default = [];
};
pipVersion = l.mkOption {
type = t.str;
description = ''
pip version to use to generate the report
'';
default = "23.1";
};
requirementsList = l.mkOption {
type = t.listOf t.str;
default = [];
description = ''
list of strings of requirements.txt entries
'';
};
requirementsFiles = l.mkOption {
type = t.listOf t.str;
default = [];
description = ''
list of requirements.txt files
'';
};
buildDependencies = l.mkOption {
type = t.attrsOf t.bool;
default = {
cython = true;
flit-core = true;
flit-scm = true;
hatch-fancy-pypi-readme = true;
hatch-nodejs-version = true;
hatch-vcs = true;
hatchling = true;
pbr = true;
pdm-pep517 = true;
poetry-core = true;
poetry-dynamic-versioning = true;
setuptools = true;
setuptools-odoo = true;
setuptools-scm = true;
versioneer = true;
wheel = true;
};
description = ''
python packages to be added only as buildInputs.
These should be somehow installable from `requirementsList` or
`requirementsFiles` too; listing them here doesn't do that automatically.
'';
example = lib.literalExpression ''
{
setuptools-scm = false; # To disable the default
easy_install = true; # To select easy_install as a buildInput
}
'';
};
nativeBuildInputs = l.mkOption {
type = t.listOf t.package;
default = [];
description = ''
list of native packages to include during metadata generation
'';
};
buildExtras = l.mkOption {
type = t.listOf t.str;
default = [];
description = ''
list of python "extras" to build with. This can be a subset of the
extras in your lock file.
'';
};
drvs = l.mkOption {
type = t.lazyAttrsOf (t.submoduleWith {
modules = [dream2nix.modules.dream2nix.core];
specialArgs = {inherit packageSets dream2nix;};
});
description = "drv-parts modules that define python dependencies";
nativeBuildInputs = l.mkOption {
type = t.listOf t.package;
default = [];
description = ''
list of native packages to include during metadata generation
'';
};
drvs = l.mkOption {
internal = true;
# hack because internal=true doesn't propagate to the submodule options
visible = "shallow";
type = t.lazyAttrsOf (t.submoduleWith {
modules = [dream2nix.modules.dream2nix.core];
specialArgs = {inherit packageSets dream2nix;};
});
description = "drv-parts modules that define python dependencies";
};
};
};
}

2
modules/flake-parts/website/default.nix
View File

@ -27,8 +27,10 @@
"_template"
];
public = lib.genAttrs [
"nodejs-granular-v3"
"nodejs-package-lock-v3"
"php-composer-lock"
"php-granular"
"pip"
"rust-cargo-lock"
"rust-crane"