nixpkgs/lib/meta.nix at 718f670e845328e9c2cecdd832835712b2cbd065 · NixOS/nixpkgs

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

/**

Some functions for manipulating meta attributes, as well as the

name attribute.

{ lib }:

let

inherit (lib)

matchAttrs

any

all

isDerivation

getBin

assertMsg

;

inherit (lib.attrsets) mapAttrs' filterAttrs;

inherit (builtins)

isString

match

typeOf

;

rec {

/**

Add to or override the meta attributes of the given

derivation.

# Inputs

`newAttrs`

: 1\. Function argument

`drv`

: 2\. Function argument

# Type

```

addMetaAttrs :: AttrSet -> Derivation -> Derivation

```

# Examples

:::{.example}

## `lib.meta.addMetaAttrs` usage example

```nix

addMetaAttrs {description = "Bla blah";} somePkg

```

:::

addMetaAttrs =

newAttrs: drv:

if drv ? overrideAttrs then

drv.overrideAttrs (old: {

meta = (old.meta or { }) // newAttrs;

})

else

drv // { meta = (drv.meta or { }) // newAttrs; };

/**

Disable Hydra builds of given derivation.

# Inputs

`drv`

: 1\. Function argument

# Type

```

dontDistribute :: Derivation -> Derivation

```

dontDistribute = drv: addMetaAttrs { hydraPlatforms = [ ]; } drv;

/**

Change the [symbolic name of a derivation](https://nixos.org/manual/nix/stable/language/derivations.html#attr-name).

:::{.warning}

Dependent derivations will be rebuilt when the symbolic name is changed.

:::

# Inputs

`name`

: 1\. Function argument

`drv`

: 2\. Function argument

# Type

```

setName :: String -> Derivation -> Derivation

```

setName = name: drv: drv // { inherit name; };

/**

Like `setName`, but takes the previous name as an argument.

# Inputs

`updater`

: 1\. Function argument

`drv`

: 2\. Function argument

# Type

```

updateName :: (String -> String) -> Derivation -> Derivation

```

# Examples

:::{.example}

## `lib.meta.updateName` usage example

```nix

updateName (oldName: oldName + "-experimental") somePkg

```

:::

updateName = updater: drv: drv // { name = updater (drv.name); };

/**

Append a suffix to the name of a package (before the version

part).

# Inputs

`suffix`

: 1\. Function argument

# Type

```

appendToName :: String -> Derivation -> Derivation

```

appendToName =

suffix:

updateName (

name:

let

x = builtins.parseDrvName name;

"${x.name}-${suffix}-${x.version}"

);

/**

Apply a function to each derivation and only to derivations in an attrset.

# Inputs

`f`

: 1\. Function argument

`set`

: 2\. Function argument

# Type

```

mapDerivationAttrset :: (Derivation -> a) -> AttrSet -> AttrSet

```

mapDerivationAttrset =

f: set: lib.mapAttrs (name: pkg: if lib.isDerivation pkg then (f pkg) else pkg) set;

/**

The default priority of packages in Nix. See `defaultPriority` in [`src/nix/profile.cc`](https://github.com/NixOS/nix/blob/master/src/nix/profile.cc#L47).

defaultPriority = 5;

/**

Set the nix-env priority of the package. Note that higher values are lower priority, and vice versa.

# Inputs

`priority`

: 1\. The priority to set.

`drv`

: 2\. Function argument

# Type

```

setPrio :: Int -> Derivation -> Derivation

```

setPrio = priority: addMetaAttrs { inherit priority; };

/**

Decrease the nix-env priority of the package, i.e., other

versions/variants of the package will be preferred.

# Inputs

`drv`

: 1\. Function argument

# Type

```

lowPrio :: Derivation -> Derivation

```

lowPrio = setPrio 10;

/**

Apply `lowPrio` to an attrset with derivations.

# Inputs

`set`

: 1\. Function argument

# Type

```

lowPrioSet :: { [String] :: Derivation } -> { [String] :: Derivation }

```

lowPrioSet = set: mapDerivationAttrset lowPrio set;

/**

Increase the nix-env priority of the package, i.e., this

version/variant of the package will be preferred.

# Inputs

`drv`

: 1\. Function argument

# Type

```

hiPrio :: Derivation -> Derivation

```

hiPrio = setPrio (-10);

/**

Apply `hiPrio` to an attrset with derivations.

# Inputs

`set`

: 1\. Function argument

# Type

```

hiPrioSet :: { [String] :: Derivation } -> { [String] :: Derivation }

```

hiPrioSet = set: mapDerivationAttrset hiPrio set;

/**

Check to see if a platform is matched by the given `meta.platforms`

element.

A `meta.platform` pattern is either

1. (legacy) a system string.

2. (modern) a pattern for the entire platform structure (see `lib.systems.inspect.platformPatterns`).

3. (modern) a pattern for the platform `parsed` field (see `lib.systems.inspect.patterns`).

We can inject these into a pattern for the whole of a structured platform,

and then match that.

# Inputs

`platform`

: 1\. Function argument

`elem`

: 2\. Function argument

# Examples

:::{.example}

## `lib.meta.platformMatch` usage example

```nix

lib.meta.platformMatch { system = "aarch64-darwin"; } "aarch64-darwin"

=> true

```

:::

platformMatch =

platform: elem:

(

# Check with simple string comparison if elem was a string.

# The majority of comparisons done with this function will be against meta.platforms

# which contains a simple platform string.

# Avoiding an attrset allocation results in significant performance gains (~2-30) across the board in OfBorg

# because this is a hot path for nixpkgs.

if isString elem then

platform ? system && elem == platform.system

else

matchAttrs (

# Normalize platform attrset.

if elem ? parsed then elem else { parsed = elem; }

) platform

);

/**

Check if a package is available on a given platform.

A package is available on a platform if both

1. One of `meta.platforms` pattern matches the given

platform, or `meta.platforms` is not present.

2. None of `meta.badPlatforms` pattern matches the given platform.

# Inputs

`platform`

: 1\. Function argument

`pkg`

: 2\. Function argument

# Examples

:::{.example}

## `lib.meta.availableOn` usage example

```nix

lib.meta.availableOn { system = "aarch64-darwin"; } pkg.zsh

=> true

```

:::

availableOn =

platform: pkg:

((!pkg ? meta.platforms) || any (platformMatch platform) pkg.meta.platforms)

&& ((!pkg ? meta.badPlatforms) || !(any (platformMatch platform) pkg.meta.badPlatforms));

/**

Mapping of SPDX ID to the attributes in lib.licenses.

For SPDX IDs, see https://spdx.org/licenses.

Note that some SPDX licenses might be missing.

# Examples

:::{.example}

## `lib.meta.licensesSpdx` usage example

```nix

lib.licensesSpdx.MIT == lib.licenses.mit

=> true

lib.licensesSpdx."MY LICENSE"

=> error: attribute 'MY LICENSE' missing

```

:::

licensesSpdx = mapAttrs' (_key: license: {

name = license.spdxId;

value = license;

}) (filterAttrs (_key: license: license ? spdxId) lib.licenses);

/**

Get the corresponding attribute in lib.licenses from the SPDX ID

or warn and fallback to `{ shortName = <license string>; }`.

For SPDX IDs, see https://spdx.org/licenses.

Note that some SPDX licenses might be missing.

# Type

```

getLicenseFromSpdxId :: String -> {

deprecated :: Bool;

free :: Bool;

fullName :: String;

redistributable :: Bool;

shortName :: String;

spdxId :: String;

url :: String;

}

```

# Examples

:::{.example}

## `lib.meta.getLicenseFromSpdxId` usage example

```nix

lib.getLicenseFromSpdxId "MIT" == lib.licenses.mit

=> true

lib.getLicenseFromSpdxId "mIt" == lib.licenses.mit

=> true

lib.getLicenseFromSpdxId "MY LICENSE"

=> trace: warning: getLicenseFromSpdxId: No license matches the given SPDX ID: MY LICENSE

=> { shortName = "MY LICENSE"; }

```

:::

getLicenseFromSpdxId =

licstr:

getLicenseFromSpdxIdOr licstr (

lib.warn "getLicenseFromSpdxId: No license with the given SPDX ID found: ${licstr}" {

shortName = licstr;

spdxId = licstr;

}

);

/**

Get the corresponding attribute in lib.licenses from the SPDX ID

or fallback to the given default value.

For SPDX IDs, see https://spdx.org/licenses.

Note that some SPDX licenses might be missing.

# Inputs

`licstr`

: 1\. SPDX ID string to find a matching license

`default`

: 2\. Fallback value when a match is not found

# Type

```

getLicenseFromSpdxIdOr :: String -> a -> ({

deprecated :: Bool;

free :: Bool;

fullName :: String;

redistributable :: Bool;

shortName :: String;

spdxId :: String;

url :: String;

} | a)

```

# Examples

:::{.example}

## `lib.meta.getLicenseFromSpdxIdOr` usage example

```nix

lib.getLicenseFromSpdxIdOr "MIT" null == lib.licenses.mit

=> true

lib.getLicenseFromSpdxId "mIt" null == lib.licenses.mit

=> true

lib.getLicenseFromSpdxIdOr "MY LICENSE" lib.licenses.free == lib.licenses.free

=> true

lib.getLicenseFromSpdxIdOr "MY LICENSE" null

=> null

lib.getLicenseFromSpdxIdOr "MY LICENSE" (throw "No SPDX ID matches MY LICENSE")

=> error: No SPDX ID matches MY LICENSE

```

:::

getLicenseFromSpdxIdOr =

let

lowercaseLicenses = lib.mapAttrs' (name: value: {

name = lib.toLower name;

inherit value;

}) licensesSpdx;

licstr: default: lowercaseLicenses.${lib.toLower licstr} or default;

/**

Get the path to the main program of a package based on `meta.mainProgram`

# Inputs

`x`

: 1\. Function argument

# Type

```

getExe :: Derivation -> StorePath

```

# Examples

:::{.example}

## `lib.meta.getExe` usage example

```nix

getExe pkgs.hello

=> "/nix/store/g124820p9hlv4lj8qplzxw1c44dxaw1k-hello-2.12/bin/hello"

getExe pkgs.mustache-go

=> "/nix/store/am9ml4f4ywvivxnkiaqwr0hyxka1xjsf-mustache-go-1.3.0/bin/mustache"

```

:::

getExe =

getExe' x (

x.meta.mainProgram or (

# This could be turned into an error when 23.05 is at end of life

lib.warn

"getExe: Package ${

lib.strings.escapeNixIdentifier x.meta.name or x.pname or x.name

} does not have the meta.mainProgram attribute. We'll assume that the main program has the same name for now, but this behavior is deprecated, because it leads to surprising errors when the assumption does not hold. If the package has a main program, please set `meta.mainProgram` in its definition to make this warning go away. Otherwise, if the package does not have a main program, or if you don't control its definition, use getExe' to specify the name to the program, such as lib.getExe' foo \"bar\"."

lib.getName

)

);

/**

Get the path of a program of a derivation.

# Inputs

`x`

: 1\. Function argument

`y`

: 2\. Function argument

# Type

```

getExe' :: Derivation -> String -> StorePath

```

# Examples

:::{.example}

## `lib.meta.getExe'` usage example

```nix

getExe' pkgs.hello "hello"

=> "/nix/store/g124820p9hlv4lj8qplzxw1c44dxaw1k-hello-2.12/bin/hello"

getExe' pkgs.imagemagick "convert"

=> "/nix/store/5rs48jamq7k6sal98ymj9l4k2bnwq515-imagemagick-7.1.1-15/bin/convert"

```

:::

getExe' =

x: y:

assert assertMsg (isDerivation x)

"lib.meta.getExe': The first argument is of type ${typeOf x}, but it should be a derivation instead.";

assert assertMsg (isString y)

"lib.meta.getExe': The second argument is of type ${typeOf y}, but it should be a string instead.";

assert assertMsg (match ".*/.*" y == null)

"lib.meta.getExe': The second argument \"${y}\" is a nested path with a \"/\" character, but it should just be the name of the executable instead.";

"${getBin x}/bin/${y}";

/**

Generate [CPE parts](#var-meta-identifiers-cpeParts) from inputs. Copies `vendor` and `version` to the output, and sets `update` to `*`.

# Inputs

`vendor`

: package's vendor

`version`

: package's version

# Type

```

cpeFullVersionWithVendor :: String -> String -> { update :: String; vendor :: String; version :: String; }

```

# Examples

:::{.example}

## `lib.meta.cpeFullVersionWithVendor` usage example

```nix

lib.meta.cpeFullVersionWithVendor "gnu" "1.2.3"

=> {

vendor = "gnu";

version = "1.2.3";

update = "*";

}

```

:::

:::{.example}

## `lib.meta.cpeFullVersionWithVendor` usage in derivations

```nix

mkDerivation rec {

version = "1.2.3";

# ...

meta = {

# ...

identifiers.cpeParts = lib.meta.cpeFullVersionWithVendor "gnu" version;

};

}

```

:::

cpeFullVersionWithVendor = vendor: version: {

inherit vendor version;

update = "*";

};

}

FilesExpand file tree

meta.nix

Latest commit

History

meta.nix

File metadata and controls