`meta_package_manager.managers.dotnet` module¶

class meta_package_manager.managers.dotnet.DotNet[source]¶

Bases: PackageManager

.NET global tools, the CLI programs the .NET SDK installs from NuGet.

Every operation goes through the dotnet tool subcommand group, forced by DotNet.pre_args, and targets the user-wide scope with --global. Global tools land under ~/.dotnet/tools and are never shared between users, so no operation escalates: elevation is only ever needed for the separate --tool-path scenario, which this wrapper does not drive.

Initialize cli_errors list.

operation_notes: ClassVar = {'cleanup': "Nothing clears only the global tools' cache; `dotnet nuget locals` empties the machine-wide folder every .NET project restores against.", 'outdated': 'The SDK ships no way to compare installed tools against NuGet without mutating them ([dotnet/sdk#22853](https://github.com/dotnet/sdk/issues/22853), closed as not planned); `upgrade --all` is unaffected.'}¶

Per-operation hints rendered in the Notes column of the manager page’s Operations table.

Keyed by the Operations member name, each value is a single short sentence explaining why the manager lacks the operation, or what makes its implementation partial: the pointer a reader needs to judge whether the gap is one they could help close. Each sentence starts with a capital and closes with a period, and starts on a word rather than a code span, so the cell reads standalone beside its row. A blank cell stays silent: a manager documenting nothing documents no gap.

The full rationale never lives here: it belongs in a comment beside the implementing method (or beside this declaration, for an operation with no method to hang it on), so the sentence on the page stays a hint and the code keeps the story. The class docstring follows the same split: it keeps only what a user needs to run the tool day to day, never how mpm wraps it.

Validated by test_operation_notes, which also checks every key matches a real operation: a key outside the enum’s vocabulary would never reach a page.

name: str = 'dotnet tool'¶

Return package manager’s common name.

Default value is based on class name.

documentation_url: str | None = 'https://learn.microsoft.com/dotnet/core/tools/global-tools'¶

Entry point of the project’s own documentation, or None when it has none.

The manual, the documentation site, or the man page of the CLI mpm drives: whichever page a user reads to learn the commands this manager wraps. Listed between homepage_url and repository_url in the links of the manager’s page, so a reader reaching for the tool’s reference finds it in the box of facts rather than in the prose below it.

Left unset where a link would state a fact twice or invent one: a tool documenting itself in its repository alone, whose README repository_url already reaches. A page about the ecosystem rather than the tool does not qualify either.

Where a project’s only site is its manual, that address belongs here and homepage_url stays unset: the slot names what the page is, and a reader reaching for the reference looks under the documentation link.

Never inherited, like every other link: the AUR helpers extending pacman each document themselves.

repository_url: str | None = 'https://github.com/dotnet/sdk'¶

Repository holding the project’s code, or None when it has no public one.

Linked from the manager’s documentation page. Also what the weekly metrics sample reads: docs/docs_update.py writes it into the [tool.repomatic.metrics] subjects of pyproject.toml when its forge answers the sampler, through a mirror for a forge that does not.

Never inherited, for the same reason as wikipedia_url: the AUR helpers extending pacman each live in a repository of their own.

logo: str | None = 'dotnet'¶

Slug of the brand mark standing for this manager in the documentation.

Names an SVG vendored under docs/assets/managers/, whose provenance and license are recorded in docs/assets/managers/logos.yaml. Inlined at the top of the manager’s page by meta_package_manager._docs; a manager leaving it unset keeps the page’s default package glyph.

Several managers legitimately share one slug, either because they wrap the same upstream (brew and cask) or because the tool has no mark of its own and its ecosystem’s stands in (apt under Debian’s swirl, cargo under Rust’s gear). Documentation-only, like homepage_url: no CLI output reads it.

keywords: tuple[str, ...] = ('nuget',)¶

Well-known names for this manager that its id does not already carry.

Merged into the PyPI keywords of pyproject.toml by update_keywords() of docs/docs_update.py, alongside every manager ID and the globally curated KEYWORDS_EXTRAS. Declare an alias here rather than in that tuple whenever it names this manager: an alias living beside the class it describes cannot outlive it, where a central entry silently rots once the manager is renamed or dropped.

Reserve KEYWORDS_EXTRAS for terms belonging to no manager in particular, like cyclonedx or package manager. Documentation-only: no CLI output reads it.

Each keyword also becomes a content rule of the issue labeller, so its precision bar applies here: see generate_content_rules(). A subclass inherits the terms of its parent without claiming them, since test_manager_keywords_have_one_owner reads what a class declares itself.

platforms: frozenset[Platform] | Group | Platform | Iterable[Platform | Group] = frozenset({Platform(id='almalinux', name='AlmaLinux'), Platform(id='alpine', name='Alpine Linux'), Platform(id='altlinux', name='ALT Linux'), Platform(id='amzn', name='Amazon Linux'), Platform(id='android', name='Android'), Platform(id='arch', name='Arch Linux'), Platform(id='buildroot', name='Buildroot'), Platform(id='cachyos', name='CachyOS'), Platform(id='centos', name='CentOS'), Platform(id='chromeos', name='ChromeOS'), Platform(id='clearlinux', name='Clear Linux OS'), Platform(id='cloudlinux', name='CloudLinux OS'), Platform(id='crux', name='CRUX'), Platform(id='debian', name='Debian'), Platform(id='endeavouros', name='EndeavourOS'), Platform(id='exherbo', name='Exherbo Linux'), Platform(id='fedora', name='Fedora'), Platform(id='generic_linux', name='Generic Linux'), Platform(id='gentoo', name='Gentoo Linux'), Platform(id='guix', name='Guix System'), Platform(id='ibm_powerkvm', name='IBM PowerKVM'), Platform(id='kali', name='Kali Linux'), Platform(id='kvmibm', name='KVM for IBM z Systems'), Platform(id='linuxmint', name='Linux Mint'), Platform(id='macos', name='macOS'), Platform(id='mageia', name='Mageia'), Platform(id='mandriva', name='Mandriva Linux'), Platform(id='manjaro', name='Manjaro Linux'), Platform(id='nixos', name='NixOS'), Platform(id='nobara', name='Nobara'), Platform(id='nutyx', name='NuTyX'), Platform(id='opensuse', name='openSUSE'), Platform(id='openwrt', name='OpenWrt'), Platform(id='oracle', name='Oracle Linux'), Platform(id='parallels', name='Parallels'), Platform(id='pidora', name='Pidora'), Platform(id='pikaos', name='PikaOS'), Platform(id='raspbian', name='Raspbian'), Platform(id='rhel', name='RedHat Enterprise Linux'), Platform(id='rocky', name='Rocky Linux'), Platform(id='scientific', name='Scientific Linux'), Platform(id='slackware', name='Slackware'), Platform(id='sles', name='SUSE Linux Enterprise Server'), Platform(id='slitaz', name='SliTaz GNU/Linux'), Platform(id='solus', name='Solus'), Platform(id='sourcemage', name='Source Mage GNU/Linux'), Platform(id='tuxedo', name='Tuxedo OS'), Platform(id='ubuntu', name='Ubuntu'), Platform(id='ultramarine', name='Ultramarine'), Platform(id='void', name='Void Linux'), Platform(id='windows', name='Windows'), Platform(id='wsl1', name='Windows Subsystem for Linux v1'), Platform(id='wsl2', name='Windows Subsystem for Linux v2'), Platform(id='xenserver', name='XenServer')})¶

List of platforms supported by the manager.

Allows for a mishmash of platforms and groups of platforms. Will be normalized into a frozenset of Platform instances at instantiation.

requirement: str | None = '>=8.0.400'¶: --all on dotnet tool update first shipped in the 8.0.400 SDK, the opening release of the 8.0.4xx feature band (dotnet/sdk#38996, merged onto release/8.0.4xx). It was never backported to 8.0.3xx, so that is the binding floor: every other operation this wrapper drives predates it by years, dotnet tool search being the youngest at 5.0.100.

extra_env: ClassVar = {'DOTNET_CLI_TELEMETRY_OPTOUT': '1', 'DOTNET_CLI_UI_LANGUAGE': 'en-us', 'DOTNET_NOLOGO': '1'}¶

Additional environment variables to add to the current context.

Automatically applied on each meta_package_manager.execution.CLIExecutor.run_cli() calls.

pre_args: tuple[str, ...] = ('tool',)¶: Every operation is a dotnet tool subcommand, so the group is forced onto each call. The version probe is exempt: it runs with auto_pre_args=False, which is what leaves it as a bare dotnet --version.

version_regexes: tuple[str, ...] = ('^(?P<version>\\d+\\.\\d+\\.\\d+\\S*)',)¶

dotnet --version prints the SDK version alone, on a single unlabelled line.

It is deliberately preferred over dotnet --info as the probe: on a machine carrying the .NET runtime but no SDK, --version fails while --info still exits 0 and reports its inventory. Since dotnet tool needs the SDK, the failure is the correct availability signal.

$ dotnet --version
9.0.306

property installed: Iterator[Package]¶

Fetch installed packages.

$ dotnet tool list --global
Package Id      Version      Commands
--------------------------------------
dotnet-ef       2.1.11       dotnet-ef

search(query, extended, exact)[source]¶

Fetch matching packages.

dotnet tool search queries NuGet’s search endpoint with packageType=dotnettool, so only .NET tools come back. NuGet offers no flag to restrict or widen that match, so both refinements are left to meta_package_manager.manager.PackageManager.refiltered_search().

Only the first two columns are captured: Authors and Downloads have no package field to land in, and Verified is a marker rather than a value.

Caution

NuGet matches the query against descriptions and tags as well as package IDs, but the default table prints no description column, so mpm cannot see why a row matched. --extended is therefore declared unsupported rather than claimed: refiltering keeps only the ID and name matches, and a package that matched on its description alone is dropped. Widening this means parsing dotnet tool search --detail, whose per-package blocks do carry a Description: line, at the cost of keying the parser on localized field labels instead of on the row shape.

$ dotnet tool search format
Package ID                              Latest Version      Authors                                                                     Downloads      Verified
---------------------------------------------------------------------------------------------------------------------------------------------------------------
dotnet-format                           4.1.131201          Microsoft                                                                   496746
bsoa.generator                          1.0.0               Microsoft                                                                   533

Return type:: Iterator[Package]

cli_names: tuple[str, ...] = ('dotnet',)¶

List of CLI names the package manager is known as.

This list of recognized CLI names is ordered by priority. That way we can influence the search of the right binary.

..hint::: This was helpful in the case of the Python transition from 2.x to 3.x, where multiple versions of the same executable were named python or python3.

By default, this property’s value is derived from the manager’s ID (see the MetaPackageManager.__init__ method above).

homepage_url: str | None = None¶

Home page of the project, only used in documentation for reference.

Left unset when the home page is the project’s repository, which repository_url names on its own, and when it is the project’s manual, which documentation_url names. Never inherited, like the other links.

id: str = 'dotnet'¶

Package manager’s ID.

Derived by defaults from the lower-cased class name in which underscores _ are replaced by dashes -.

This ID must be unique among all package manager definitions and lower-case, as they’re used as feature flags for the mpm CLI.

install(package_id, version=None)[source]¶

Install one package.

$ dotnet tool install --global dotnetsay

$ dotnet tool install --global dotnetsay --version 2.1.7

Return type:: str

virtual: bool = False¶

Should we expose the package manager to the user?

Virtual package manager are just skeleton classes used to factorize code among managers of the same family.

wikipedia_url: str | None = None¶

English Wikipedia article about the project, or None when it has none.

Listed last in the links of the manager’s documentation page. The article covers the project that home page names, or is a redirect Wikipedia keeps under the project’s name, landing on the part of a broader article that describes it: Cargo_(software) opens the Cargo section of the Rust article. An article that merely mentions the project does not count, nor does one about a related subject: lazy is a Neovim plugin manager, and the Neovim article is not about it.

Never inherited: the metaclass resets it to None on any class not declaring its own. A subclass often wraps a distinct project, like the six AUR helpers extending pacman, and would otherwise present pacman’s article as its own. Documentation-only, like homepage_url.

upgrade_all_cli()[source]¶

Generates the CLI to upgrade all packages.

$ dotnet tool update --global --all

Return type:: tuple[str, ...]

upgrade_one_cli(package_id, version=None)[source]¶

Generates the CLI to upgrade one package.

dotnet tool update is implemented upstream as an uninstall followed by a reinstall, and refuses to move a tool backwards: a version older than the installed one needs a remove first.

$ dotnet tool update --global dotnetsay

$ dotnet tool update --global dotnetsay --version 2.1.7

Return type:: tuple[str, ...]

remove(package_id)[source]¶

Remove one package.

$ dotnet tool uninstall --global dotnetsay

Return type:: str

meta_package_manager.managers.dotnet module¶

`meta_package_manager.managers.dotnet` module¶