Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
M
micropython
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
card10
micropython
Commits
5de064fb
Commit
5de064fb
authored
7 years ago
by
Paul Sokolovsky
Browse files
Options
Downloads
Patches
Plain Diff
docs/library/index: Elaborate uPy libraries intro.
parent
b8068895
No related branches found
No related tags found
No related merge requests found
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/library/index.rst
+14
-12
14 additions, 12 deletions
docs/library/index.rst
with
14 additions
and
12 deletions
docs/library/index.rst
+
14
−
12
View file @
5de064fb
...
@@ -9,34 +9,36 @@ MicroPython libraries
...
@@ -9,34 +9,36 @@ MicroPython libraries
* MicroPython implements a subset of Python functionality for each module.
* MicroPython implements a subset of Python functionality for each module.
* To ease extensibility, MicroPython versions of standard Python modules
* To ease extensibility, MicroPython versions of standard Python modules
usually have ``u`` (micro) prefix.
usually have ``u`` (
"
micro
"
) prefix.
* Any particular MicroPython variant or port may miss any feature/function
* Any particular MicroPython variant or port may miss any feature/function
described in this general documentation, due to resource constraints.
described in this general documentation (due to resource constraints or
other limitations).
This chapter describes modules (function and class libraries) which are built
This chapter describes modules (function and class libraries) which are built
into MicroPython. There are a few categories of modules:
into MicroPython. There are a few categories of
such
modules:
* Modules which implement a subset of standard Python functionality and are not
* Modules which implement a subset of standard Python functionality and are not
intended to be extended by the user.
intended to be extended by the user.
* Modules which implement a subset of Python functionality, with a provision
* Modules which implement a subset of Python functionality, with a provision
for extension by the user (via Python code).
for extension by the user (via Python code).
* Modules which implement MicroPython extensions to the Python standard libraries.
* Modules which implement MicroPython extensions to the Python standard libraries.
* Modules specific to a particular port and thus not portable.
* Modules specific to a particular
`MicroPython
port
`
and thus not portable.
Note about the availability of modules and their contents: This documentation
Note about the availability of
the
modules and their contents: This documentation
in general aspires to describe all modules and functions/classes which are
in general aspires to describe all modules and functions/classes which are
implemented in MicroPython. However, MicroPython is highly configurable, and
implemented in MicroPython
project
. However, MicroPython is highly configurable, and
each port to a particular board/embedded system makes available only a subset
each port to a particular board/embedded system makes available only a subset
of MicroPython libraries. For officially supported ports, there is an effort
of MicroPython libraries. For officially supported ports, there is an effort
to either filter out non-applicable items, or mark individual descriptions
to either filter out non-applicable items, or mark individual descriptions
with "Availability:" clauses describing which ports provide a given feature.
with "Availability:" clauses describing which ports provide a given feature.
With that in mind, please still be warned that some functions/classes
With that in mind, please still be warned that some functions/classes
in a module (or even the entire module) described in this documentation may be
in a module (or even the entire module) described in this documentation
**
may be
unavailable in a particular build of MicroPython on a particular
board
. The
unavailable
**
in a particular build of MicroPython on a particular
system
. The
best place to find general information of the availability/non-availability
best place to find general information of the availability/non-availability
of a particular feature is the "General Information" section which contains
of a particular feature is the "General Information" section which contains
information pertaining to a specific port.
information pertaining to a specific
`MicroPython
port
`
.
Beyond the built-in libraries described in this documentation, many more
Beyond the built-in libraries described in this documentation, many more
modules from the Python standard library, as well as further MicroPython
modules from the Python standard library, as well as further MicroPython
...
@@ -58,9 +60,9 @@ what done by the `micropython-lib` project mentioned above).
...
@@ -58,9 +60,9 @@ what done by the `micropython-lib` project mentioned above).
On some embedded platforms, where it may be cumbersome to add Python-level
On some embedded platforms, where it may be cumbersome to add Python-level
wrapper modules to achieve naming compatibility with CPython, micro-modules
wrapper modules to achieve naming compatibility with CPython, micro-modules
are available both by their u-name, and also by their non-u-name. The
are available both by their u-name, and also by their non-u-name. The
non-u-name can be overridden by a file of that name in your
package
path.
non-u-name can be overridden by a file of that name in your
library path (``sys.
path
``)
.
For example, ``import json`` will first search for a file ``json.py`` or
For example, ``import json`` will first search for a file ``json.py``
(
or
package
directory ``json`` and load that
packag
e if it is found. If nothing is found,
directory ``json``
)
and load that
modul
e if it is found. If nothing is found,
it will fallback to loading the built-in ``ujson`` module.
it will fallback to loading the built-in ``ujson`` module.
.. only:: port_unix
.. only:: port_unix
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment