Sylvestre Ledru
8f033c8241
Convert testing/{awsy,condprofile,docs,geckodriver,marionette,
mozbase,mozharness,perfdocs,performance,raptor,talos,web-platform}
RST documentation files to MyST-flavored Markdown.
Skips testing/perfdocs/generated/* (auto-generated by mach perfdocs)
and testing/web-platform/tests/* (third-party test trees).
- Move treeherder-try frontmatter substitutions under the new myst
topmatter key.
- Allow the pre-existing autodoc Unknown target warning for
mozprofile.permissions to keep the build clean.
- Refresh allowed-warnings glob for manifest-sandbox download from
.rst to .md.
Differential Revision: https://phabricator.services.mozilla.com/D304228
2.3 KiB
{mod}mozinfo --- Get system information
Throughout Mozilla python code, checking the underlying platform is done in many different ways. The various checks needed lead to a lot of copy+pasting, leaving the reader to wonder....is this specific check necessary for (e.g.) an operating system? Because information is not consolidated, checks are not done consistently, nor is it defined what we are checking for.
mozinfo
proposes to solve this problem. mozinfo is a bridge interface,
making the underlying (complex) plethora of OS and architecture
combinations conform to a subset of values of relevance to
Mozilla software. The current implementation exposes relevant keys and
values such as: os, version, bits, and processor. Additionally, the
service pack in use is available on the windows platform.
API Usage
mozinfo is a python package. Downloading the software and running
python setup.py develop will allow you to do import mozinfo
from python.
mozinfo.py
is the only file contained in this package,
so if you need a single-file solution, you can just download or call
this file through the web.
The top level attributes (os, version, bits, processor) are
available as module globals:
if mozinfo.os == 'win': ...
In addition, mozinfo exports a dictionary, mozinfo.info, that
contain these values. mozinfo also exports:
choices: a dictionary of possible values for os, bits, and processormain: the console_script entry point for mozinfounknown: a singleton denoting a value that cannot be determined
unknown has the string representation "UNKNOWN".
unknown will evaluate as False in python:
if not mozinfo.os: ... # unknown!
Command Line Usage
mozinfo comes with a command line program, mozinfo which may be used to
diagnose one's current system.
Example output:
os: linux
version: Ubuntu 10.10
bits: 32
processor: x86
Three of these fields, os, bits, and processor, have a finite set of
choices. You may display the value of these choices using
mozinfo --os, mozinfo --bits, and mozinfo --processor.
mozinfo --help documents command-line usage.
.. automodule:: mozinfo
:members: