sample_id stringlengths 26 53 | family_id stringlengths 16 42 | text stringlengths 141 7.78k | language stringclasses 1
value | profile stringclasses 1
value | version_context stringclasses 7
values | source_refs stringlengths 293 384 |
|---|---|---|---|---|---|---|
dp-pt-click-8.5-documentation.md-0 | dp-Click-documentation.md | # Help Pages
```{currentmodule} click
```
Click makes it very easy to document your command line tools. For most things Click automatically generates help pages for you. By design the text is customizable, but the layout is not.
## Help Texts
Commands and options accept help arguments. For commands, the docstring o... | en | software_docs | Click 8.5.0 | [{"license": "BSD-3-Clause", "locator": "click-8.5.0/docs/documentation.md#codepoints:0:3805", "revision": "8.5.0+sha256:ba0d2089de75ea0310e2dde03160e6ca10009947fb95a182f9b54021bb272e34", "source_id": "click-8.5:documentation.md", "uri": "https://files.pythonhosted.org/packages/c7/0e/7fa0ef50764b67090eca4114772a2abf8b6... |
dp-pt-click-8.5-documentation.md-1 | dp-Click-documentation.md | ## Showing Defaults
To control the appearance of defaults pass `show_default`.
```{eval-rst}
.. click:example::
@click.command()
@click.option('--n', default=1, show_default=False, help='number of dots')
def dots(n):
click.echo('.' * n)
.. click:run::
invoke(dots, args=['--help'])
```
For s... | en | software_docs | Click 8.5.0 | [{"license": "BSD-3-Clause", "locator": "click-8.5.0/docs/documentation.md#codepoints:3805:7110", "revision": "8.5.0+sha256:ba0d2089de75ea0310e2dde03160e6ca10009947fb95a182f9b54021bb272e34", "source_id": "click-8.5:documentation.md", "uri": "https://files.pythonhosted.org/packages/c7/0e/7fa0ef50764b67090eca4114772a2abf... |
dp-pt-click-8.5-documentation.md-2 | dp-Click-documentation.md | ## Placeholder / Meta Variable
The default placeholder variable ([meta variable](https://en.wikipedia.org/wiki/Metasyntactic_variable#IETF_Requests_for_Comments)) in the help pages is the parameter name in uppercase with underscores. This can be changed for Commands and Parameters with the `options_metavar` and `metav... | en | software_docs | Click 8.5.0 | [{"license": "BSD-3-Clause", "locator": "click-8.5.0/docs/documentation.md#codepoints:7110:10035", "revision": "8.5.0+sha256:ba0d2089de75ea0310e2dde03160e6ca10009947fb95a182f9b54021bb272e34", "source_id": "click-8.5:documentation.md", "uri": "https://files.pythonhosted.org/packages/c7/0e/7fa0ef50764b67090eca4114772a2ab... |
dp-pt-flask-3.1-deploying-eventlet.rst-0 | dp-Flask-deploying-eventlet.rst | :orphan:
eventlet
========
`Eventlet is no longer maintained.`__ Use :doc:`/deploying/gevent` instead.
__ https://eventlet.readthedocs.io
| en | software_docs | Flask 3.1.3 | [{"license": "BSD-3-Clause", "locator": "flask-3.1.3/docs/deploying/eventlet.rst#codepoints:0:141", "revision": "3.1.3+sha256:0ef0e52b8a9cd932855379197dd8f94047b359ca0a78695144304cb45f87c9eb", "source_id": "flask-3.1:deploying/eventlet.rst", "uri": "https://files.pythonhosted.org/packages/26/00/35d85dcce6c57fdc871f3867... |
dp-pt-flask-3.1-deploying-nginx.rst-0 | dp-Flask-deploying-nginx.rst | nginx
=====
`nginx`_ is a fast, production level HTTP server. When serving your
application with one of the WSGI servers listed in :doc:`index`, it is
often good or necessary to put a dedicated HTTP server in front of it.
This "reverse proxy" can handle incoming requests, TLS, and other
security and performance concer... | en | software_docs | Flask 3.1.3 | [{"license": "BSD-3-Clause", "locator": "flask-3.1.3/docs/deploying/nginx.rst#codepoints:0:2316", "revision": "3.1.3+sha256:0ef0e52b8a9cd932855379197dd8f94047b359ca0a78695144304cb45f87c9eb", "source_id": "flask-3.1:deploying/nginx.rst", "uri": "https://files.pythonhosted.org/packages/26/00/35d85dcce6c57fdc871f3867d465d... |
dp-pt-flask-3.1-deploying-proxy_fix.rst-0 | dp-Flask-deploying-proxy_fix.rst | Tell Flask it is Behind a Proxy
===============================
When using a reverse proxy, or many Python hosting platforms, the proxy
will intercept and forward all external requests to the local WSGI
server.
From the WSGI server and Flask application's perspectives, requests are
now coming from the HTTP server to ... | en | software_docs | Flask 3.1.3 | [{"license": "BSD-3-Clause", "locator": "flask-3.1.3/docs/deploying/proxy_fix.rst#codepoints:0:1365", "revision": "3.1.3+sha256:0ef0e52b8a9cd932855379197dd8f94047b359ca0a78695144304cb45f87c9eb", "source_id": "flask-3.1:deploying/proxy_fix.rst", "uri": "https://files.pythonhosted.org/packages/26/00/35d85dcce6c57fdc871f3... |
dp-pt-flask-3.1-design.rst-0 | dp-Flask-design.rst | Design Decisions in Flask
=========================
If you are curious why Flask does certain things the way it does and not
differently, this section is for you. This should give you an idea about
some of the design decisions that may appear arbitrary and surprising at
first, especially in direct comparison with oth... | en | software_docs | Flask 3.1.3 | [{"license": "BSD-3-Clause", "locator": "flask-3.1.3/docs/design.rst#codepoints:0:3713", "revision": "3.1.3+sha256:0ef0e52b8a9cd932855379197dd8f94047b359ca0a78695144304cb45f87c9eb", "source_id": "flask-3.1:design.rst", "uri": "https://files.pythonhosted.org/packages/26/00/35d85dcce6c57fdc871f3867d465d780f302a175ea360f6... |
dp-pt-flask-3.1-design.rst-1 | dp-Flask-design.rst | The Routing System
------------------
Flask uses the Werkzeug routing system which was designed to
automatically order routes by complexity. This means that you can declare
routes in arbitrary order and they will still work as expected. This is a
requirement if you want to properly implement decorator based routing
... | en | software_docs | Flask 3.1.3 | [{"license": "BSD-3-Clause", "locator": "flask-3.1.3/docs/design.rst#codepoints:3713:6201", "revision": "3.1.3+sha256:0ef0e52b8a9cd932855379197dd8f94047b359ca0a78695144304cb45f87c9eb", "source_id": "flask-3.1:design.rst", "uri": "https://files.pythonhosted.org/packages/26/00/35d85dcce6c57fdc871f3867d465d780f302a175ea36... |
dp-pt-flask-3.1-design.rst-2 | dp-Flask-design.rst | What does "micro" mean?
-----------------------
“Micro” does not mean that your whole web application has to fit into a single
Python file (although it certainly can), nor does it mean that Flask is lacking
in functionality. The "micro" in microframework means Flask aims to keep the
core simple but extensible. Flask w... | en | software_docs | Flask 3.1.3 | [{"license": "BSD-3-Clause", "locator": "flask-3.1.3/docs/design.rst#codepoints:6201:9843", "revision": "3.1.3+sha256:0ef0e52b8a9cd932855379197dd8f94047b359ca0a78695144304cb45f87c9eb", "source_id": "flask-3.1:design.rst", "uri": "https://files.pythonhosted.org/packages/26/00/35d85dcce6c57fdc871f3867d465d780f302a175ea36... |
dp-pt-flask-3.1-design.rst-3 | dp-Flask-design.rst | What Flask is, What Flask is Not
--------------------------------
Flask will never have a database layer. It will not have a form library
or anything else in that direction. Flask itself just bridges to Werkzeug
to implement a proper WSGI application and to Jinja to handle templating.
It also binds to a few common s... | en | software_docs | Flask 3.1.3 | [{"license": "BSD-3-Clause", "locator": "flask-3.1.3/docs/design.rst#codepoints:9843:11062", "revision": "3.1.3+sha256:0ef0e52b8a9cd932855379197dd8f94047b359ca0a78695144304cb45f87c9eb", "source_id": "flask-3.1:design.rst", "uri": "https://files.pythonhosted.org/packages/26/00/35d85dcce6c57fdc871f3867d465d780f302a175ea3... |
dp-pt-flask-3.1-patterns-caching.rst-0 | dp-Flask-patterns-caching.rst | Caching
=======
When your application runs slow, throw some caches in. Well, at least
it's the easiest way to speed up things. What does a cache do? Say you
have a function that takes some time to complete but the results would
still be good enough if they were 5 minutes old. So then the idea is that
you actually ... | en | software_docs | Flask 3.1.3 | [{"license": "BSD-3-Clause", "locator": "flask-3.1.3/docs/patterns/caching.rst#codepoints:0:653", "revision": "3.1.3+sha256:0ef0e52b8a9cd932855379197dd8f94047b359ca0a78695144304cb45f87c9eb", "source_id": "flask-3.1:patterns/caching.rst", "uri": "https://files.pythonhosted.org/packages/26/00/35d85dcce6c57fdc871f3867d465... |
dp-pt-flask-3.1-patterns-celery.rst-0 | dp-Flask-patterns-celery.rst | Background Tasks with Celery
============================
If your application has a long running task, such as processing some uploaded data or
sending email, you don't want to wait for it to finish during a request. Instead, use a
task queue to send the necessary data to another process that will run the task in the
... | en | software_docs | Flask 3.1.3 | [{"license": "BSD-3-Clause", "locator": "flask-3.1.3/docs/patterns/celery.rst#codepoints:0:3479", "revision": "3.1.3+sha256:0ef0e52b8a9cd932855379197dd8f94047b359ca0a78695144304cb45f87c9eb", "source_id": "flask-3.1:patterns/celery.rst", "uri": "https://files.pythonhosted.org/packages/26/00/35d85dcce6c57fdc871f3867d465d... |
dp-pt-flask-3.1-patterns-celery.rst-1 | dp-Flask-patterns-celery.rst | Application Factory
-------------------
When using the Flask application factory pattern, call the ``celery_init_app`` function
inside the factory. It sets ``app.extensions["celery"]`` to the Celery app object, which
can be used to get the Celery app from the Flask app returned by the factory.
.. code-block:: python
... | en | software_docs | Flask 3.1.3 | [{"license": "BSD-3-Clause", "locator": "flask-3.1.3/docs/patterns/celery.rst#codepoints:3479:6618", "revision": "3.1.3+sha256:0ef0e52b8a9cd932855379197dd8f94047b359ca0a78695144304cb45f87c9eb", "source_id": "flask-3.1:patterns/celery.rst", "uri": "https://files.pythonhosted.org/packages/26/00/35d85dcce6c57fdc871f3867d4... |
dp-pt-flask-3.1-patterns-celery.rst-2 | dp-Flask-patterns-celery.rst | Getting Results
---------------
To fetch the result of the task we started above, we'll add another route that takes the
result id we returned before. We return whether the task is finished (ready), whether it
finished successfully, and what the return value (or error) was if it is finished.
.. code-block:: python
... | en | software_docs | Flask 3.1.3 | [{"license": "BSD-3-Clause", "locator": "flask-3.1.3/docs/patterns/celery.rst#codepoints:6618:8670", "revision": "3.1.3+sha256:0ef0e52b8a9cd932855379197dd8f94047b359ca0a78695144304cb45f87c9eb", "source_id": "flask-3.1:patterns/celery.rst", "uri": "https://files.pythonhosted.org/packages/26/00/35d85dcce6c57fdc871f3867d4... |
dp-pt-flask-3.1-patterns-sqlalchemy.rst-0 | dp-Flask-patterns-sqlalchemy.rst | SQLAlchemy in Flask
===================
Many people prefer `SQLAlchemy`_ for database access. In this case it's
encouraged to use a package instead of a module for your flask application
and drop the models into a separate module (:doc:`packages`). While that
is not necessary, it makes a lot of sense.
There are four... | en | software_docs | Flask 3.1.3 | [{"license": "BSD-3-Clause", "locator": "flask-3.1.3/docs/patterns/sqlalchemy.rst#codepoints:0:3892", "revision": "3.1.3+sha256:0ef0e52b8a9cd932855379197dd8f94047b359ca0a78695144304cb45f87c9eb", "source_id": "flask-3.1:patterns/sqlalchemy.rst", "uri": "https://files.pythonhosted.org/packages/26/00/35d85dcce6c57fdc871f3... |
dp-pt-flask-3.1-patterns-sqlalchemy.rst-1 | dp-Flask-patterns-sqlalchemy.rst | Manual Object Relational Mapping
--------------------------------
Manual object relational mapping has a few upsides and a few downsides
versus the declarative approach from above. The main difference is that
you define tables and classes separately and map them together. It's more
flexible but a little more to type... | en | software_docs | Flask 3.1.3 | [{"license": "BSD-3-Clause", "locator": "flask-3.1.3/docs/patterns/sqlalchemy.rst#codepoints:3892:7294", "revision": "3.1.3+sha256:0ef0e52b8a9cd932855379197dd8f94047b359ca0a78695144304cb45f87c9eb", "source_id": "flask-3.1:patterns/sqlalchemy.rst", "uri": "https://files.pythonhosted.org/packages/26/00/35d85dcce6c57fdc87... |
dp-pt-flask-3.1-quickstart.rst-0 | dp-Flask-quickstart.rst | Quickstart
==========
Eager to get started? This page gives a good introduction to Flask.
Follow :doc:`installation` to set up a project and install Flask first.
A Minimal Application
---------------------
A minimal Flask application looks something like this:
.. code-block:: python
from flask import Flask
... | en | software_docs | Flask 3.1.3 | [{"license": "BSD-3-Clause", "locator": "flask-3.1.3/docs/quickstart.rst#codepoints:0:2910", "revision": "3.1.3+sha256:0ef0e52b8a9cd932855379197dd8f94047b359ca0a78695144304cb45f87c9eb", "source_id": "flask-3.1:quickstart.rst", "uri": "https://files.pythonhosted.org/packages/26/00/35d85dcce6c57fdc871f3867d465d780f302a17... |
dp-pt-flask-3.1-quickstart.rst-1 | dp-Flask-quickstart.rst | Debug Mode
----------
The ``flask run`` command can do more than just start the development
server. By enabling debug mode, the server will automatically reload if
code changes, and will show an interactive debugger in the browser if an
error occurs during a request.
.. image:: _static/debugger.png
:align: center... | en | software_docs | Flask 3.1.3 | [{"license": "BSD-3-Clause", "locator": "flask-3.1.3/docs/quickstart.rst#codepoints:2910:6675", "revision": "3.1.3+sha256:0ef0e52b8a9cd932855379197dd8f94047b359ca0a78695144304cb45f87c9eb", "source_id": "flask-3.1:quickstart.rst", "uri": "https://files.pythonhosted.org/packages/26/00/35d85dcce6c57fdc871f3867d465d780f302... |
dp-pt-flask-3.1-quickstart.rst-2 | dp-Flask-quickstart.rst | Unique URLs / Redirection Behavior
``````````````````````````````````
The following two rules differ in their use of a trailing slash. ::
@app.route('/projects/')
def projects():
return 'The project page'
@app.route('/about')
def about():
return 'The about page'
The canonical URL for... | en | software_docs | Flask 3.1.3 | [{"license": "BSD-3-Clause", "locator": "flask-3.1.3/docs/quickstart.rst#codepoints:6675:9395", "revision": "3.1.3+sha256:0ef0e52b8a9cd932855379197dd8f94047b359ca0a78695144304cb45f87c9eb", "source_id": "flask-3.1:quickstart.rst", "uri": "https://files.pythonhosted.org/packages/26/00/35d85dcce6c57fdc871f3867d465d780f302... |
dp-pt-flask-3.1-quickstart.rst-3 | dp-Flask-quickstart.rst | HTTP Methods
````````````
Web applications use different HTTP methods when accessing URLs. You should
familiarize yourself with the HTTP methods as you work with Flask. By default,
a route only answers to ``GET`` requests. You can use the ``methods`` argument
of the :meth:`~flask.Flask.route` decorator to handle diffe... | en | software_docs | Flask 3.1.3 | [{"license": "BSD-3-Clause", "locator": "flask-3.1.3/docs/quickstart.rst#codepoints:9395:11349", "revision": "3.1.3+sha256:0ef0e52b8a9cd932855379197dd8f94047b359ca0a78695144304cb45f87c9eb", "source_id": "flask-3.1:quickstart.rst", "uri": "https://files.pythonhosted.org/packages/26/00/35d85dcce6c57fdc871f3867d465d780f30... |
dp-pt-flask-3.1-quickstart.rst-4 | dp-Flask-quickstart.rst | Rendering Templates
-------------------
Generating HTML from within Python is not fun, and actually pretty
cumbersome because you have to do the HTML escaping on your own to keep
the application secure. Because of that Flask configures the `Jinja
<https://palletsprojects.com/p/jinja/>`_ template engine for you automa... | en | software_docs | Flask 3.1.3 | [{"license": "BSD-3-Clause", "locator": "flask-3.1.3/docs/quickstart.rst#codepoints:11349:15092", "revision": "3.1.3+sha256:0ef0e52b8a9cd932855379197dd8f94047b359ca0a78695144304cb45f87c9eb", "source_id": "flask-3.1:quickstart.rst", "uri": "https://files.pythonhosted.org/packages/26/00/35d85dcce6c57fdc871f3867d465d780f3... |
dp-pt-flask-3.1-quickstart.rst-5 | dp-Flask-quickstart.rst | Accessing Request Data
----------------------
For web applications it's crucial to react to the data a client sends to
the server. In Flask this information is provided by the global
:class:`~flask.request` object. If you have some experience with Python
you might be wondering how that object can be global and how F... | en | software_docs | Flask 3.1.3 | [{"license": "BSD-3-Clause", "locator": "flask-3.1.3/docs/quickstart.rst#codepoints:15092:17535", "revision": "3.1.3+sha256:0ef0e52b8a9cd932855379197dd8f94047b359ca0a78695144304cb45f87c9eb", "source_id": "flask-3.1:quickstart.rst", "uri": "https://files.pythonhosted.org/packages/26/00/35d85dcce6c57fdc871f3867d465d780f3... |
dp-pt-flask-3.1-quickstart.rst-6 | dp-Flask-quickstart.rst | The Request Object
``````````````````
The request object is documented in the API section and we will not cover
it here in detail (see :class:`~flask.Request`). Here is a broad overview of
some of the most common operations. First of all you have to import it from
the ``flask`` module::
from flask import request... | en | software_docs | Flask 3.1.3 | [{"license": "BSD-3-Clause", "locator": "flask-3.1.3/docs/quickstart.rst#codepoints:17535:21275", "revision": "3.1.3+sha256:0ef0e52b8a9cd932855379197dd8f94047b359ca0a78695144304cb45f87c9eb", "source_id": "flask-3.1:quickstart.rst", "uri": "https://files.pythonhosted.org/packages/26/00/35d85dcce6c57fdc871f3867d465d780f3... |
dp-pt-flask-3.1-quickstart.rst-7 | dp-Flask-quickstart.rst | Cookies
```````
To access cookies you can use the :attr:`~flask.Request.cookies`
attribute. To set cookies you can use the
:attr:`~flask.Response.set_cookie` method of response objects. The
:attr:`~flask.Request.cookies` attribute of request objects is a
dictionary with all the cookies the client transmits. If you ... | en | software_docs | Flask 3.1.3 | [{"license": "BSD-3-Clause", "locator": "flask-3.1.3/docs/quickstart.rst#codepoints:21275:23928", "revision": "3.1.3+sha256:0ef0e52b8a9cd932855379197dd8f94047b359ca0a78695144304cb45f87c9eb", "source_id": "flask-3.1:quickstart.rst", "uri": "https://files.pythonhosted.org/packages/26/00/35d85dcce6c57fdc871f3867d465d780f3... |
dp-pt-flask-3.1-quickstart.rst-8 | dp-Flask-quickstart.rst | About Responses
---------------
The return value from a view function is automatically converted into
a response object for you. If the return value is a string it's
converted into a response object with the string as response body, a
``200 OK`` status code and a :mimetype:`text/html` mimetype. If the
return value is ... | en | software_docs | Flask 3.1.3 | [{"license": "BSD-3-Clause", "locator": "flask-3.1.3/docs/quickstart.rst#codepoints:23928:27082", "revision": "3.1.3+sha256:0ef0e52b8a9cd932855379197dd8f94047b359ca0a78695144304cb45f87c9eb", "source_id": "flask-3.1:quickstart.rst", "uri": "https://files.pythonhosted.org/packages/26/00/35d85dcce6c57fdc871f3867d465d780f3... |
dp-pt-flask-3.1-quickstart.rst-9 | dp-Flask-quickstart.rst | Sessions
--------
In addition to the request object there is also a second object called
:class:`~flask.session` which allows you to store information specific to a
user from one request to the next. This is implemented on top of cookies
for you and signs the cookies cryptographically. What this means is that
the us... | en | software_docs | Flask 3.1.3 | [{"license": "BSD-3-Clause", "locator": "flask-3.1.3/docs/quickstart.rst#codepoints:27082:30220", "revision": "3.1.3+sha256:0ef0e52b8a9cd932855379197dd8f94047b359ca0a78695144304cb45f87c9eb", "source_id": "flask-3.1:quickstart.rst", "uri": "https://files.pythonhosted.org/packages/26/00/35d85dcce6c57fdc871f3867d465d780f3... |
dp-pt-flask-3.1-quickstart.rst-10 | dp-Flask-quickstart.rst | Logging
-------
.. versionadded:: 0.3
Sometimes you might be in a situation where you deal with data that
should be correct, but actually is not. For example you may have
some client-side code that sends an HTTP request to the server
but it's obviously malformed. This might be caused by a user tampering
with the da... | en | software_docs | Flask 3.1.3 | [{"license": "BSD-3-Clause", "locator": "flask-3.1.3/docs/quickstart.rst#codepoints:30220:32219", "revision": "3.1.3+sha256:0ef0e52b8a9cd932855379197dd8f94047b359ca0a78695144304cb45f87c9eb", "source_id": "flask-3.1:quickstart.rst", "uri": "https://files.pythonhosted.org/packages/26/00/35d85dcce6c57fdc871f3867d465d780f3... |
dp-pt-flask-3.1-tutorial-database.rst-0 | dp-Flask-tutorial-database.rst | .. currentmodule:: flask
Define and Access the Database
==============================
The application will use a `SQLite`_ database to store users and posts.
Python comes with built-in support for SQLite in the :mod:`sqlite3`
module.
SQLite is convenient because it doesn't require setting up a separate
database ser... | en | software_docs | Flask 3.1.3 | [{"license": "BSD-3-Clause", "locator": "flask-3.1.3/docs/tutorial/database.rst#codepoints:0:3011", "revision": "3.1.3+sha256:0ef0e52b8a9cd932855379197dd8f94047b359ca0a78695144304cb45f87c9eb", "source_id": "flask-3.1:tutorial/database.rst", "uri": "https://files.pythonhosted.org/packages/26/00/35d85dcce6c57fdc871f3867d... |
dp-pt-flask-3.1-tutorial-database.rst-1 | dp-Flask-tutorial-database.rst | Create the Tables
-----------------
In SQLite, data is stored in *tables* and *columns*. These need to be
created before you can store and retrieve data. Flaskr will store users
in the ``user`` table, and posts in the ``post`` table. Create a file
with the SQL commands needed to create empty tables:
.. code-block:: s... | en | software_docs | Flask 3.1.3 | [{"license": "BSD-3-Clause", "locator": "flask-3.1.3/docs/tutorial/database.rst#codepoints:3011:6290", "revision": "3.1.3+sha256:0ef0e52b8a9cd932855379197dd8f94047b359ca0a78695144304cb45f87c9eb", "source_id": "flask-3.1:tutorial/database.rst", "uri": "https://files.pythonhosted.org/packages/26/00/35d85dcce6c57fdc871f38... |
dp-pt-flask-3.1-tutorial-database.rst-2 | dp-Flask-tutorial-database.rst | Initialize the Database File
----------------------------
Now that ``init-db`` has been registered with the app, it can be called
using the ``flask`` command, similar to the ``run`` command from the
previous page.
.. note::
If you're still running the server from the previous page, you can
either stop the se... | en | software_docs | Flask 3.1.3 | [{"license": "BSD-3-Clause", "locator": "flask-3.1.3/docs/tutorial/database.rst#codepoints:6290:7025", "revision": "3.1.3+sha256:0ef0e52b8a9cd932855379197dd8f94047b359ca0a78695144304cb45f87c9eb", "source_id": "flask-3.1:tutorial/database.rst", "uri": "https://files.pythonhosted.org/packages/26/00/35d85dcce6c57fdc871f38... |
dp-pt-jinja-3.1-switching.rst-0 | dp-Jinja-switching.rst | Switching From Other Template Engines
=====================================
This is a brief guide on some of the differences between Jinja syntax
and other template languages. See :doc:`/templates` for a comprehensive
guide to Jinja syntax and features.
Django
------
If you have previously worked with Django templa... | en | software_docs | Jinja 3.1.6 | [{"license": "BSD-3-Clause", "locator": "jinja2-3.1.6/docs/switching.rst#codepoints:0:3069", "revision": "3.1.6+sha256:0137fb05990d35f1275a587e9aee6d56da821fc83491a0fb838183be43f66d6d", "source_id": "jinja-3.1:switching.rst", "uri": "https://files.pythonhosted.org/packages/df/bf/f7da0350254c0ed7c72f3e33cef02e048281fec7... |
dp-pt-jinja-3.1-switching.rst-1 | dp-Jinja-switching.rst | Mako
----
You can configure Jinja to look more like Mako:
.. code-block:: python
env = Environment(
block_start_string="<%",
block_end_string="%>",
variable_start_string="${",
variable_end_string="}",
comment_start_string="<%doc>",
commend_end_string="</%doc>",
... | en | software_docs | Jinja 3.1.6 | [{"license": "BSD-3-Clause", "locator": "jinja2-3.1.6/docs/switching.rst#codepoints:3069:4413", "revision": "3.1.6+sha256:0137fb05990d35f1275a587e9aee6d56da821fc83491a0fb838183be43f66d6d", "source_id": "jinja-3.1:switching.rst", "uri": "https://files.pythonhosted.org/packages/df/bf/f7da0350254c0ed7c72f3e33cef02e048281f... |
dp-pt-jinja-3.1-tricks.rst-0 | dp-Jinja-tricks.rst | Tips and Tricks
===============
.. highlight:: html+jinja
This part of the documentation shows some tips and tricks for Jinja
templates.
.. _null-default-fallback:
Null-Default Fallback
---------------------
Jinja supports dynamic inheritance and does not distinguish between parent
and child template as long as n... | en | software_docs | Jinja 3.1.6 | [{"license": "BSD-3-Clause", "locator": "jinja2-3.1.6/docs/tricks.rst#codepoints:0:3168", "revision": "3.1.6+sha256:0137fb05990d35f1275a587e9aee6d56da821fc83491a0fb838183be43f66d6d", "source_id": "jinja-3.1:tricks.rst", "uri": "https://files.pythonhosted.org/packages/df/bf/f7da0350254c0ed7c72f3e33cef02e048281fec7ecec5f... |
dp-pt-cpython-3.13-c-api-float.rst-0 | dp-Python-c-api-float.rst | .. highlight:: c
.. _floatobjects:
Floating-Point Objects
======================
.. index:: pair: object; floating-point
.. c:type:: PyFloatObject
This subtype of :c:type:`PyObject` represents a Python floating-point object.
.. c:var:: PyTypeObject PyFloat_Type
This instance of :c:type:`PyTypeObject` rep... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/c-api/float.rst#codepoints:0:3608", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:c-api/float.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-c-api-float.rst-1 | dp-Python-c-api-float.rst | Pack functions
^^^^^^^^^^^^^^
The pack routines write 2, 4 or 8 bytes, starting at *p*. *le* is an
:c:expr:`int` argument, non-zero if you want the bytes string in little-endian
format (exponent last, at ``p+1``, ``p+3``, or ``p+6`` ``p+7``), zero if you
want big-endian format (exponent first, at *p*). The :c:macro:`P... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/c-api/float.rst#codepoints:3608:5923", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:c-api/float.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-c-api-gen.rst-0 | dp-Python-c-api-gen.rst | .. highlight:: c
.. _gen-objects:
Generator Objects
-----------------
Generator objects are what Python uses to implement generator iterators. They
are normally created by iterating over a function that yields values, rather
than explicitly calling :c:func:`PyGen_New` or :c:func:`PyGen_NewWithQualName`.
.. c:type:... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/c-api/gen.rst#codepoints:0:1383", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:c-api/gen.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-c-api-long.rst-1 | dp-Python-c-api-long.rst | Integer Objects
---------------
.. index:: pair: object; long integer
pair: object; integer
All integers are implemented as "long" integer objects of arbitrary size.
On error, most ``PyLong_As*`` APIs return ``(return type)-1`` which cannot be
distinguished from a number. Use :c:func:`PyErr_Occurred` to ... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/c-api/long.rst#codepoints:36:4018", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:c-api/long.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-c-api-long.rst-2 | dp-Python-c-api-long.rst |
Create a Python integer from the pointer *p*. The pointer value can be
retrieved from the resulting value using :c:func:`PyLong_AsVoidPtr`.
.. c:function:: PyObject* PyLong_FromNativeBytes(const void* buffer, size_t n_bytes, int flags)
Create a Python integer from the value contained in the first *n_bytes*... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/c-api/long.rst#codepoints:3772:7715", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:c-api/long.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-c-api-long.rst-3 | dp-Python-c-api-long.rst |
Raise :exc:`OverflowError` if the value of *obj* is out of range for a
:c:expr:`long long`.
Returns ``-1`` on error. Use :c:func:`PyErr_Occurred` to disambiguate.
.. versionchanged:: 3.8
Use :meth:`~object.__index__` if available.
.. versionchanged:: 3.10
This function will no longer use... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/c-api/long.rst#codepoints:7461:11424", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:c-api/long.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-c-api-long.rst-4 | dp-Python-c-api-long.rst |
Returns ``(unsigned long)-1`` on error. Use :c:func:`PyErr_Occurred` to
disambiguate.
.. versionchanged:: 3.8
Use :meth:`~object.__index__` if available.
.. versionchanged:: 3.10
This function will no longer use :meth:`~object.__int__`.
.. c:function:: unsigned long long PyLong_AsUnsignedL... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/c-api/long.rst#codepoints:11157:14982", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:c-api/long.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-c-api-long.rst-5 | dp-Python-c-api-long.rst | be large enough to hold the value. This may be larger than technically
necessary, but not unreasonably so. If *n_bytes=0*, *buffer* may be
``NULL``.
.. note::
Passing *n_bytes=0* to this function is not an accurate way to determine
the bit length of the value.
To get at the entire Python v... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/c-api/long.rst#codepoints:14694:20050", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:c-api/long.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.12-c-api-long.rst-1 | dp-Python-c-api-long.rst | Integer Objects
---------------
.. index:: pair: object; long integer
pair: object; integer
All integers are implemented as "long" integer objects of arbitrary size.
On error, most ``PyLong_As*`` APIs return ``(return type)-1`` which cannot be
distinguished from a number. Use :c:func:`PyErr_Occurred` to ... | en | software_docs | Python 3.12.7 | [{"license": "PSF-2.0", "locator": "Python-3.12.7/Doc/c-api/long.rst#codepoints:36:4010", "revision": "3.12.7+sha256:73ac8fe780227bf371add8373c3079f42a0dc62deff8d612cd15a618082ab623", "source_id": "cpython-3.12:c-api/long.rst", "uri": "https://www.python.org/ftp/python/3.12.7/Python-3.12.7.tgz"}] |
dp-pt-cpython-3.12-c-api-long.rst-2 | dp-Python-c-api-long.rst |
.. c:function:: PyObject* PyLong_FromVoidPtr(void *p)
Create a Python integer from the pointer *p*. The pointer value can be
retrieved from the resulting value using :c:func:`PyLong_AsVoidPtr`.
.. XXX alias PyLong_AS_LONG (for now)
.. c:function:: long PyLong_AsLong(PyObject *obj)
.. index::
single... | en | software_docs | Python 3.12.7 | [{"license": "PSF-2.0", "locator": "Python-3.12.7/Doc/c-api/long.rst#codepoints:3716:7638", "revision": "3.12.7+sha256:73ac8fe780227bf371add8373c3079f42a0dc62deff8d612cd15a618082ab623", "source_id": "cpython-3.12:c-api/long.rst", "uri": "https://www.python.org/ftp/python/3.12.7/Python-3.12.7.tgz"}] |
dp-pt-cpython-3.12-c-api-long.rst-3 | dp-Python-c-api-long.rst | be an instance of :c:type:`PyLongObject`.
Raise :exc:`OverflowError` if the value of *pylong* is out of range for a
:c:type:`Py_ssize_t`.
Returns ``-1`` on error. Use :c:func:`PyErr_Occurred` to disambiguate.
.. c:function:: unsigned long PyLong_AsUnsignedLong(PyObject *pylong)
.. index::
sin... | en | software_docs | Python 3.12.7 | [{"license": "PSF-2.0", "locator": "Python-3.12.7/Doc/c-api/long.rst#codepoints:7341:12488", "revision": "3.12.7+sha256:73ac8fe780227bf371add8373c3079f42a0dc62deff8d612cd15a618082ab623", "source_id": "cpython-3.12:c-api/long.rst", "uri": "https://www.python.org/ftp/python/3.12.7/Python-3.12.7.tgz"}] |
dp-pt-cpython-3.13-c-api-memory.rst-0 | dp-Python-c-api-memory.rst | .. highlight:: c
.. _memory:
*****************
Memory Management
*****************
.. sectionauthor:: Vladimir Marangozov <Vladimir.Marangozov@inrialpes.fr>
.. _memoryoverview:
| en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/c-api/memory.rst#codepoints:0:185", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:c-api/memory.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-c-api-memory.rst-1 | dp-Python-c-api-memory.rst | Overview
========
Memory management in Python involves a private heap containing all Python
objects and data structures. The management of this private heap is ensured
internally by the *Python memory manager*. The Python memory manager has
different components which deal with various dynamic storage management aspec... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/c-api/memory.rst#codepoints:185:4218", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:c-api/memory.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-c-api-memory.rst-2 | dp-Python-c-api-memory.rst | Allocator Domains
=================
.. _allocator-domains:
All allocating functions belong to one of three different "domains" (see also
:c:type:`PyMemAllocatorDomain`). These domains represent different allocation
strategies and are optimized for different purposes. The specific details on
how every domain allocates... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/c-api/memory.rst#codepoints:4218:6292", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:c-api/memory.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-c-api-memory.rst-3 | dp-Python-c-api-memory.rst | Raw Memory Interface
====================
The following function sets are wrappers to the system allocator. These
functions are thread-safe, the :term:`GIL <global interpreter lock>` does not
need to be held.
The :ref:`default raw memory allocator <default-memory-allocators>` uses
the following functions: :c:func:`ma... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/c-api/memory.rst#codepoints:6292:8729", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:c-api/memory.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-c-api-memory.rst-4 | dp-Python-c-api-memory.rst | Memory Interface
================
The following function sets, modeled after the ANSI C standard, but specifying
behavior when requesting zero bytes, are available for allocating and releasing
memory from the Python heap.
The :ref:`default memory allocator <default-memory-allocators>` uses the
:ref:`pymalloc memory a... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/c-api/memory.rst#codepoints:8729:12481", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:c-api/memory.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-c-api-memory.rst-5 | dp-Python-c-api-memory.rst | Object allocators
=================
The following function sets, modeled after the ANSI C standard, but specifying
behavior when requesting zero bytes, are available for allocating and releasing
memory from the Python heap.
.. note::
There is no guarantee that the memory returned by these allocators can be
su... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/c-api/memory.rst#codepoints:12481:15199", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:c-api/memory.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-c-api-memory.rst-6 | dp-Python-c-api-memory.rst | Default Memory Allocators
=========================
Default memory allocators:
=============================== ==================== ================== ===================== ====================
Configuration Name PyMem_RawMalloc PyMem_Malloc PyObject_Malloc
======... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/c-api/memory.rst#codepoints:15199:16821", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:c-api/memory.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-c-api-memory.rst-7 | dp-Python-c-api-memory.rst | Customize Memory Allocators
===========================
.. versionadded:: 3.4
.. c:type:: PyMemAllocatorEx
Structure used to describe a memory block allocator. The structure has
the following fields:
+----------------------------------------------------------+---------------------------------------+
| F... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/c-api/memory.rst#codepoints:16821:21473", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:c-api/memory.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-c-api-memory.rst-8 | dp-Python-c-api-memory.rst | Debug hooks on the Python memory allocators
===========================================
When :ref:`Python is built in debug mode <debug-build>`, the
:c:func:`PyMem_SetupDebugHooks` function is called at the :ref:`Python
preinitialization <c-preinit>` to setup debug hooks on Python memory allocators
to detect memory er... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/c-api/memory.rst#codepoints:21473:26569", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:c-api/memory.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-c-api-memory.rst-9 | dp-Python-c-api-memory.rst | The pymalloc allocator
======================
Python has a *pymalloc* allocator optimized for small objects (smaller or equal
to 512 bytes) with a short lifetime. It uses memory mappings called "arenas"
with a fixed size of either 256 KiB on 32-bit platforms or 1 MiB on 64-bit
platforms. It falls back to :c:func:`PyMe... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/c-api/memory.rst#codepoints:26569:30000", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:c-api/memory.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-c-api-memory.rst-10 | dp-Python-c-api-memory.rst | Examples
========
Here is the example from section :ref:`memoryoverview`, rewritten so that the
I/O buffer is allocated from the Python heap by using the first function set::
PyObject *res;
char *buf = (char *) PyMem_Malloc(BUFSIZ); /* for I/O */
if (buf == NULL)
return PyErr_NoMemory();
/* ...Do ... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/c-api/memory.rst#codepoints:30000:31848", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:c-api/memory.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.12-c-api-memory.rst-2 | dp-Python-c-api-memory.rst | Allocator Domains
=================
.. _allocator-domains:
All allocating functions belong to one of three different "domains" (see also
:c:type:`PyMemAllocatorDomain`). These domains represent different allocation
strategies and are optimized for different purposes. The specific details on
how every domain allocates... | en | software_docs | Python 3.12.7 | [{"license": "PSF-2.0", "locator": "Python-3.12.7/Doc/c-api/memory.rst#codepoints:4218:6025", "revision": "3.12.7+sha256:73ac8fe780227bf371add8373c3079f42a0dc62deff8d612cd15a618082ab623", "source_id": "cpython-3.12:c-api/memory.rst", "uri": "https://www.python.org/ftp/python/3.12.7/Python-3.12.7.tgz"}] |
dp-pt-cpython-3.12-c-api-memory.rst-4 | dp-Python-c-api-memory.rst | Memory Interface
================
The following function sets, modeled after the ANSI C standard, but specifying
behavior when requesting zero bytes, are available for allocating and releasing
memory from the Python heap.
The :ref:`default memory allocator <default-memory-allocators>` uses the
:ref:`pymalloc memory a... | en | software_docs | Python 3.12.7 | [{"license": "PSF-2.0", "locator": "Python-3.12.7/Doc/c-api/memory.rst#codepoints:8462:12192", "revision": "3.12.7+sha256:73ac8fe780227bf371add8373c3079f42a0dc62deff8d612cd15a618082ab623", "source_id": "cpython-3.12:c-api/memory.rst", "uri": "https://www.python.org/ftp/python/3.12.7/Python-3.12.7.tgz"}] |
dp-pt-cpython-3.12-c-api-memory.rst-6 | dp-Python-c-api-memory.rst | Default Memory Allocators
=========================
Default memory allocators:
=============================== ==================== ================== ===================== ====================
Configuration Name PyMem_RawMalloc PyMem_Malloc PyObject_Malloc
======... | en | software_docs | Python 3.12.7 | [{"license": "PSF-2.0", "locator": "Python-3.12.7/Doc/c-api/memory.rst#codepoints:14910:16395", "revision": "3.12.7+sha256:73ac8fe780227bf371add8373c3079f42a0dc62deff8d612cd15a618082ab623", "source_id": "cpython-3.12:c-api/memory.rst", "uri": "https://www.python.org/ftp/python/3.12.7/Python-3.12.7.tgz"}] |
dp-pt-cpython-3.12-c-api-memory.rst-9 | dp-Python-c-api-memory.rst | The pymalloc allocator
======================
Python has a *pymalloc* allocator optimized for small objects (smaller or equal
to 512 bytes) with a short lifetime. It uses memory mappings called "arenas"
with a fixed size of either 256 KiB on 32-bit platforms or 1 MiB on 64-bit
platforms. It falls back to :c:func:`PyMe... | en | software_docs | Python 3.12.7 | [{"license": "PSF-2.0", "locator": "Python-3.12.7/Doc/c-api/memory.rst#codepoints:26143:29221", "revision": "3.12.7+sha256:73ac8fe780227bf371add8373c3079f42a0dc62deff8d612cd15a618082ab623", "source_id": "cpython-3.12:c-api/memory.rst", "uri": "https://www.python.org/ftp/python/3.12.7/Python-3.12.7.tgz"}] |
dp-pt-cpython-3.13-c-api-none.rst-0 | dp-Python-c-api-none.rst | .. highlight:: c
.. _noneobject:
The ``None`` Object
-------------------
.. index:: pair: object; None
Note that the :c:type:`PyTypeObject` for ``None`` is not directly exposed in the
Python/C API. Since ``None`` is a singleton, testing for object identity (using
``==`` in C) is sufficient. There is no :c:func:`!P... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/c-api/none.rst#codepoints:0:655", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:c-api/none.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.12-c-api-none.rst-0 | dp-Python-c-api-none.rst | .. highlight:: c
.. _noneobject:
The ``None`` Object
-------------------
.. index:: pair: object; None
Note that the :c:type:`PyTypeObject` for ``None`` is not directly exposed in the
Python/C API. Since ``None`` is a singleton, testing for object identity (using
``==`` in C) is sufficient. There is no :c:func:`!P... | en | software_docs | Python 3.12.7 | [{"license": "PSF-2.0", "locator": "Python-3.12.7/Doc/c-api/none.rst#codepoints:0:672", "revision": "3.12.7+sha256:73ac8fe780227bf371add8373c3079f42a0dc62deff8d612cd15a618082ab623", "source_id": "cpython-3.12:c-api/none.rst", "uri": "https://www.python.org/ftp/python/3.12.7/Python-3.12.7.tgz"}] |
dp-pt-cpython-3.13-copyright.rst-0 | dp-Python-copyright.rst | *********
Copyright
*********
Python and this documentation is:
Copyright © 2001-2024 Python Software Foundation. All rights reserved.
Copyright © 2000 BeOpen.com. All rights reserved.
Copyright © 1995-2000 Corporation for National Research Initiatives. All rights
reserved.
Copyright © 1991-1995 Stichting Mathemat... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/copyright.rst#codepoints:0:447", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:copyright.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.12-copyright.rst-0 | dp-Python-copyright.rst | *********
Copyright
*********
Python and this documentation is:
Copyright © 2001-2023 Python Software Foundation. All rights reserved.
Copyright © 2000 BeOpen.com. All rights reserved.
Copyright © 1995-2000 Corporation for National Research Initiatives. All rights
reserved.
Copyright © 1991-1995 Stichting Mathemat... | en | software_docs | Python 3.12.7 | [{"license": "PSF-2.0", "locator": "Python-3.12.7/Doc/copyright.rst#codepoints:0:447", "revision": "3.12.7+sha256:73ac8fe780227bf371add8373c3079f42a0dc62deff8d612cd15a618082ab623", "source_id": "cpython-3.12:copyright.rst", "uri": "https://www.python.org/ftp/python/3.12.7/Python-3.12.7.tgz"}] |
dp-pt-cpython-3.13-extending-index.rst-0 | dp-Python-extending-index.rst | .. _extending-index:
##################################################
Extending and Embedding the Python Interpreter
##################################################
This document describes how to write modules in C or C++ to extend the Python
interpreter with new modules. Those modules can not only define new... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/extending/index.rst#codepoints:0:2878", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:extending/index.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-glossary.rst-1 | dp-Python-glossary.rst | ********
Glossary
********
.. if you add new entries, keep the alphabetical sorting!
.. glossary::
``>>>``
The default Python prompt of the :term:`interactive` shell. Often
seen for code examples which can be executed interactively in the
interpreter.
``...``
Can refer to:
* Th... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/glossary.rst#codepoints:15:3776", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:glossary.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-glossary.rst-2 | dp-Python-glossary.rst | <faq-argument-vs-parameter>`, and :pep:`362`.
asynchronous context manager
An object which controls the environment seen in an
:keyword:`async with` statement by defining :meth:`~object.__aenter__` and
:meth:`~object.__aexit__` methods. Introduced by :pep:`492`.
asynchronous generator
... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/glossary.rst#codepoints:3483:7239", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:glossary.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-glossary.rst-3 | dp-Python-glossary.rst | ``'wb'`` or ``'rb+'``), :data:`sys.stdin.buffer <sys.stdin>`,
:data:`sys.stdout.buffer <sys.stdout>`, and instances of
:class:`io.BytesIO` and :class:`gzip.GzipFile`.
See also :term:`text file` for a file object able to read and write
:class:`str` objects.
borrowed reference
In ... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/glossary.rst#codepoints:6950:10448", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:glossary.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-glossary.rst-4 | dp-Python-glossary.rst | normally contain method definitions which operate on instances of the
class.
class variable
A variable defined in a class and intended to be modified only at
class level (i.e., not in an instance of the class).
complex number
An extension of the familiar real number system in which... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/glossary.rst#codepoints:10208:14108", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:glossary.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-glossary.rst-5 | dp-Python-glossary.rst |
@staticmethod
def f(arg):
...
The same concept exists for classes, but is less commonly used there. See
the documentation for :ref:`function definitions <function>` and
:ref:`class definitions <class>` for more about decorators.
descriptor
Any object which d... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/glossary.rst#codepoints:13826:17458", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:glossary.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-glossary.rst-6 | dp-Python-glossary.rst | exceptions if the assumption proves false. This clean and fast style is
characterized by the presence of many :keyword:`try` and :keyword:`except`
statements. The technique contrasts with the :term:`LBYL` style
common to many other languages such as C.
expression
A piece of syntax wh... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/glossary.rst#codepoints:17178:21121", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:glossary.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-glossary.rst-7 | dp-Python-glossary.rst |
free threading
A threading model where multiple threads can run Python bytecode
simultaneously within the same interpreter. This is in contrast to
the :term:`global interpreter lock` which allows only one thread to
execute Python bytecode at a time. See :pep:`703`.
function
A ser... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/glossary.rst#codepoints:20824:24795", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:glossary.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-glossary.rst-8 | dp-Python-glossary.rst | for different types. Which implementation should be used during a call is
determined by the dispatch algorithm.
See also the :term:`single dispatch` glossary entry, the
:func:`functools.singledispatch` decorator, and :pep:`443`.
generic type
A :term:`type` that can be parameterized; t... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/glossary.rst#codepoints:24540:28528", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:glossary.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-glossary.rst-9 | dp-Python-glossary.rst | tuples. Such an object cannot be altered. A new object has to
be created if a different value has to be stored. They play an important
role in places where a constant hash value is needed, for example as a key
in a dictionary.
import path
A list of locations (or :term:`path entries ... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/glossary.rst#codepoints:28273:32036", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:glossary.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-glossary.rst-10 | dp-Python-glossary.rst | :func:`iter` or deal with iterator objects yourself. The :keyword:`for`
statement does that automatically for you, creating a temporary unnamed
variable to hold the iterator for the duration of the loop. See also
:term:`iterator`, :term:`sequence`, and :term:`generator`.
iterator
An ... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/glossary.rst#codepoints:31737:35550", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:glossary.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-glossary.rst-11 | dp-Python-glossary.rst | code, ``if key in mapping: return mapping[key]`` can fail if another
thread removes *key* from *mapping* after the test, but before the lookup.
This issue can be solved with locks or by using the EAFP approach.
list
A built-in Python :term:`sequence`. Despite its name it is more akin
... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/glossary.rst#codepoints:35320:39276", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:glossary.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-glossary.rst-12 | dp-Python-glossary.rst |
module
An object that serves as an organizational unit of Python code. Modules
have a namespace containing arbitrary Python objects. Modules are loaded
into Python by the process of :term:`importing`.
See also :term:`package`.
module spec
A namespace containing the import-relate... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/glossary.rst#codepoints:39017:42870", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:glossary.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-glossary.rst-13 | dp-Python-glossary.rst | properties, :meth:`~object.__getattribute__`, class methods, and static
methods.
object
Any data with state (attributes or value) and defined behavior
(methods). Also the ultimate base class of any :term:`new-style
class`.
optimized scope
A scope where target local variable ... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/glossary.rst#codepoints:42611:46598", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:glossary.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-glossary.rst-14 | dp-Python-glossary.rst | A :term:`finder` returned by a callable on :data:`sys.path_hooks`
(i.e. a :term:`path entry hook`) which knows how to locate modules given
a :term:`path entry`.
See :class:`importlib.abc.PathEntryFinder` for the methods that path entry
finders implement.
path entry hook
A callab... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/glossary.rst#codepoints:46311:50305", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:glossary.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-glossary.rst-15 | dp-Python-glossary.rst | people unfamiliar with Python sometimes use a numerical counter instead::
for i in range(len(food)):
print(food[i])
As opposed to the cleaner, Pythonic method::
for piece in food:
print(piece)
qualified name
A dotted name showing the "path" from a m... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/glossary.rst#codepoints:50050:53903", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:glossary.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-glossary.rst-16 | dp-Python-glossary.rst | c not in 'abc'}`` generates the set of strings ``{'r', 'd'}``. See
:ref:`comprehensions`.
single dispatch
A form of :term:`generic function` dispatch where the implementation is
chosen based on the type of a single argument.
slice
An object usually containing a portion of a :term:... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/glossary.rst#codepoints:53648:60791", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:glossary.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.12-glossary.rst-1 | dp-Python-glossary.rst | ********
Glossary
********
.. if you add new entries, keep the alphabetical sorting!
.. glossary::
``>>>``
The default Python prompt of the interactive shell. Often seen for code
examples which can be executed interactively in the interpreter.
``...``
Can refer to:
* The default Pyth... | en | software_docs | Python 3.12.7 | [{"license": "PSF-2.0", "locator": "Python-3.12.7/Doc/glossary.rst#codepoints:15:3898", "revision": "3.12.7+sha256:73ac8fe780227bf371add8373c3079f42a0dc62deff8d612cd15a618082ab623", "source_id": "cpython-3.12:glossary.rst", "uri": "https://www.python.org/ftp/python/3.12.7/Python-3.12.7.tgz"}] |
dp-pt-cpython-3.12-glossary.rst-2 | dp-Python-glossary.rst | evaluated value is assigned to the local variable.
See also the :term:`parameter` glossary entry, the FAQ question on
:ref:`the difference between arguments and parameters
<faq-argument-vs-parameter>`, and :pep:`362`.
asynchronous context manager
An object which controls the environme... | en | software_docs | Python 3.12.7 | [{"license": "PSF-2.0", "locator": "Python-3.12.7/Doc/glossary.rst#codepoints:3654:7601", "revision": "3.12.7+sha256:73ac8fe780227bf371add8373c3079f42a0dc62deff8d612cd15a618082ab623", "source_id": "cpython-3.12:glossary.rst", "uri": "https://www.python.org/ftp/python/3.12.7/Python-3.12.7.tgz"}] |
dp-pt-cpython-3.12-glossary.rst-6 | dp-Python-glossary.rst | exceptions if the assumption proves false. This clean and fast style is
characterized by the presence of many :keyword:`try` and :keyword:`except`
statements. The technique contrasts with the :term:`LBYL` style
common to many other languages such as C.
expression
A piece of syntax wh... | en | software_docs | Python 3.12.7 | [{"license": "PSF-2.0", "locator": "Python-3.12.7/Doc/glossary.rst#codepoints:17540:21474", "revision": "3.12.7+sha256:73ac8fe780227bf371add8373c3079f42a0dc62deff8d612cd15a618082ab623", "source_id": "cpython-3.12:glossary.rst", "uri": "https://www.python.org/ftp/python/3.12.7/Python-3.12.7.tgz"}] |
dp-pt-cpython-3.12-glossary.rst-7 | dp-Python-glossary.rst |
function
A series of statements which returns some value to a caller. It can also
be passed zero or more :term:`arguments <argument>` which may be used in
the execution of the body. See also :term:`parameter`, :term:`method`,
and the :ref:`function` section.
function annotation
An ... | en | software_docs | Python 3.12.7 | [{"license": "PSF-2.0", "locator": "Python-3.12.7/Doc/glossary.rst#codepoints:21186:25097", "revision": "3.12.7+sha256:73ac8fe780227bf371add8373c3079f42a0dc62deff8d612cd15a618082ab623", "source_id": "cpython-3.12:glossary.rst", "uri": "https://www.python.org/ftp/python/3.12.7/Python-3.12.7.tgz"}] |
dp-pt-cpython-3.12-glossary.rst-8 | dp-Python-glossary.rst |
generic type
A :term:`type` that can be parameterized; typically a
:ref:`container class<sequence-types>` such as :class:`list` or
:class:`dict`. Used for :term:`type hints <type hint>` and
:term:`annotations <annotation>`.
For more details, see :ref:`generic alias types<types-generic... | en | software_docs | Python 3.12.7 | [{"license": "PSF-2.0", "locator": "Python-3.12.7/Doc/glossary.rst#codepoints:24844:28831", "revision": "3.12.7+sha256:73ac8fe780227bf371add8373c3079f42a0dc62deff8d612cd15a618082ab623", "source_id": "cpython-3.12:glossary.rst", "uri": "https://www.python.org/ftp/python/3.12.7/Python-3.12.7.tgz"}] |
dp-pt-cpython-3.12-glossary.rst-9 | dp-Python-glossary.rst | searched by the :term:`path based finder` for modules to import. During
import, this list of locations usually comes from :data:`sys.path`, but
for subpackages it may also come from the parent package's ``__path__``
attribute.
importing
The process by which Python code in one module is... | en | software_docs | Python 3.12.7 | [{"license": "PSF-2.0", "locator": "Python-3.12.7/Doc/glossary.rst#codepoints:28579:31938", "revision": "3.12.7+sha256:73ac8fe780227bf371add8373c3079f42a0dc62deff8d612cd15a618082ab623", "source_id": "cpython-3.12:glossary.rst", "uri": "https://www.python.org/ftp/python/3.12.7/Python-3.12.7.tgz"}] |
dp-pt-cpython-3.12-glossary.rst-10 | dp-Python-glossary.rst | :func:`iter` or deal with iterator objects yourself. The :keyword:`for`
statement does that automatically for you, creating a temporary unnamed
variable to hold the iterator for the duration of the loop. See also
:term:`iterator`, :term:`sequence`, and :term:`generator`.
iterator
An ... | en | software_docs | Python 3.12.7 | [{"license": "PSF-2.0", "locator": "Python-3.12.7/Doc/glossary.rst#codepoints:31639:35507", "revision": "3.12.7+sha256:73ac8fe780227bf371add8373c3079f42a0dc62deff8d612cd15a618082ab623", "source_id": "cpython-3.12:glossary.rst", "uri": "https://www.python.org/ftp/python/3.12.7/Python-3.12.7.tgz"}] |
dp-pt-cpython-3.12-glossary.rst-11 | dp-Python-glossary.rst | This issue can be solved with locks or by using the EAFP approach.
list
A built-in Python :term:`sequence`. Despite its name it is more akin
to an array in other languages than to a linked list since access to
elements is *O*\ (1).
list comprehension
A compact way to process all o... | en | software_docs | Python 3.12.7 | [{"license": "PSF-2.0", "locator": "Python-3.12.7/Doc/glossary.rst#codepoints:35245:39206", "revision": "3.12.7+sha256:73ac8fe780227bf371add8373c3079f42a0dc62deff8d612cd15a618082ab623", "source_id": "cpython-3.12:glossary.rst", "uri": "https://www.python.org/ftp/python/3.12.7/Python-3.12.7.tgz"}] |
dp-pt-cpython-3.12-glossary.rst-12 | dp-Python-glossary.rst | into Python by the process of :term:`importing`.
See also :term:`package`.
module spec
A namespace containing the import-related information used to load a
module. An instance of :class:`importlib.machinery.ModuleSpec`.
MRO
See :term:`method resolution order`.
mutable
Mu... | en | software_docs | Python 3.12.7 | [{"license": "PSF-2.0", "locator": "Python-3.12.7/Doc/glossary.rst#codepoints:38956:42896", "revision": "3.12.7+sha256:73ac8fe780227bf371add8373c3079f42a0dc62deff8d612cd15a618082ab623", "source_id": "cpython-3.12:glossary.rst", "uri": "https://www.python.org/ftp/python/3.12.7/Python-3.12.7.tgz"}] |
dp-pt-cpython-3.12-glossary.rst-13 | dp-Python-glossary.rst | class`.
package
A Python :term:`module` which can contain submodules or recursively,
subpackages. Technically, a package is a Python module with a
``__path__`` attribute.
See also :term:`regular package` and :term:`namespace package`.
parameter
A named entity in a :term:`fu... | en | software_docs | Python 3.12.7 | [{"license": "PSF-2.0", "locator": "Python-3.12.7/Doc/glossary.rst#codepoints:42624:46175", "revision": "3.12.7+sha256:73ac8fe780227bf371add8373c3079f42a0dc62deff8d612cd15a618082ab623", "source_id": "cpython-3.12:glossary.rst", "uri": "https://www.python.org/ftp/python/3.12.7/Python-3.12.7.tgz"}] |
dp-pt-cpython-3.12-glossary.rst-14 | dp-Python-glossary.rst | entry finder` if it knows how to find modules on a specific :term:`path
entry`.
path based finder
One of the default :term:`meta path finders <meta path finder>` which
searches an :term:`import path` for modules.
path-like object
An object representing a file system path. A path-li... | en | software_docs | Python 3.12.7 | [{"license": "PSF-2.0", "locator": "Python-3.12.7/Doc/glossary.rst#codepoints:45933:49541", "revision": "3.12.7+sha256:73ac8fe780227bf371add8373c3079f42a0dc62deff8d612cd15a618082ab623", "source_id": "cpython-3.12:glossary.rst", "uri": "https://www.python.org/ftp/python/3.12.7/Python-3.12.7.tgz"}] |
dp-pt-cpython-3.12-glossary.rst-15 | dp-Python-glossary.rst | people unfamiliar with Python sometimes use a numerical counter instead::
for i in range(len(food)):
print(food[i])
As opposed to the cleaner, Pythonic method::
for piece in food:
print(piece)
qualified name
A dotted name showing the "path" from a m... | en | software_docs | Python 3.12.7 | [{"license": "PSF-2.0", "locator": "Python-3.12.7/Doc/glossary.rst#codepoints:49286:53009", "revision": "3.12.7+sha256:73ac8fe780227bf371add8373c3079f42a0dc62deff8d612cd15a618082ab623", "source_id": "cpython-3.12:glossary.rst", "uri": "https://www.python.org/ftp/python/3.12.7/Python-3.12.7.tgz"}] |
dp-pt-cpython-3.12-glossary.rst-16 | dp-Python-glossary.rst | c not in 'abc'}`` generates the set of strings ``{'r', 'd'}``. See
:ref:`comprehensions`.
single dispatch
A form of :term:`generic function` dispatch where the implementation is
chosen based on the type of a single argument.
slice
An object usually containing a portion of a :term:... | en | software_docs | Python 3.12.7 | [{"license": "PSF-2.0", "locator": "Python-3.12.7/Doc/glossary.rst#codepoints:52754:59460", "revision": "3.12.7+sha256:73ac8fe780227bf371add8373c3079f42a0dc62deff8d612cd15a618082ab623", "source_id": "cpython-3.12:glossary.rst", "uri": "https://www.python.org/ftp/python/3.12.7/Python-3.12.7.tgz"}] |
dp-pt-cpython-3.13-howto-clinic.rst-0 | dp-Python-howto-clinic.rst | :orphan:
.. This page is retained solely for existing links to /howto/clinic.html.
Direct readers to the devguide.
**********************
Argument Clinic How-To
**********************
.. note::
The Argument Clinic How-TO has been moved to the `Python Developer's Guide
<https://devguide.python.org/developm... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/howto/clinic.rst#codepoints:0:343", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:howto/clinic.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-howto-cporting.rst-0 | dp-Python-howto-cporting.rst | .. highlight:: c
.. _cporting-howto:
*************************************
Porting Extension Modules to Python 3
*************************************
We recommend the following resources for porting extension modules to Python 3:
* The `Migrating C extensions`_ chapter from
*Supporting Python 3: An in-depth guid... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/howto/cporting.rst#codepoints:0:1006", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:howto/cporting.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-howto-perf_profiling.rst-1 | dp-Python-howto-perf_profiling.rst | ==============================================
Python support for the Linux ``perf`` profiler
==============================================
:author: Pablo Galindo
`The Linux perf profiler <https://perf.wiki.kernel.org>`_
is a very powerful tool that allows you to profile and obtain
information about the performance ... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/howto/perf_profiling.rst#codepoints:51:7831", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:howto/perf_profiling.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-howto-perf_profiling.rst-2 | dp-Python-howto-perf_profiling.rst | How to enable ``perf`` profiling support
----------------------------------------
``perf`` profiling support can be enabled either from the start using
the environment variable :envvar:`PYTHONPERFSUPPORT` or the
:option:`-X perf <-X>` option,
or dynamically using :func:`sys.activate_stack_trampoline` and
:func:`sys.de... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/howto/perf_profiling.rst#codepoints:7831:9720", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:howto/perf_profiling.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.13-howto-perf_profiling.rst-3 | dp-Python-howto-perf_profiling.rst | How to work without frame pointers
----------------------------------
If you are working with a Python interpreter that has been compiled without
frame pointers, you can still use the ``perf`` profiler, but the overhead will be
a bit higher because Python needs to generate unwinding information for every
Python functi... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/howto/perf_profiling.rst#codepoints:9720:12621", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:howto/perf_profiling.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
dp-pt-cpython-3.12-howto-perf_profiling.rst-2 | dp-Python-howto-perf_profiling.rst | How to enable ``perf`` profiling support
----------------------------------------
``perf`` profiling support can be enabled either from the start using
the environment variable :envvar:`PYTHONPERFSUPPORT` or the
:option:`-X perf <-X>` option,
or dynamically using :func:`sys.activate_stack_trampoline` and
:func:`sys.de... | en | software_docs | Python 3.12.7 | [{"license": "PSF-2.0", "locator": "Python-3.12.7/Doc/howto/perf_profiling.rst#codepoints:7831:9610", "revision": "3.12.7+sha256:73ac8fe780227bf371add8373c3079f42a0dc62deff8d612cd15a618082ab623", "source_id": "cpython-3.12:howto/perf_profiling.rst", "uri": "https://www.python.org/ftp/python/3.12.7/Python-3.12.7.tgz"}] |
dp-pt-cpython-3.13-howto-sockets.rst-0 | dp-Python-howto-sockets.rst | .. _socket-howto:
****************************
Socket Programming HOWTO
****************************
:Author: Gordon McMillan
.. topic:: Abstract
Sockets are used nearly everywhere, but are one of the most severely
misunderstood technologies around. This is a 10,000 foot overview of sockets.
It's not re... | en | software_docs | Python 3.13.0 | [{"license": "PSF-2.0", "locator": "Python-3.13.0/Doc/howto/sockets.rst#codepoints:0:2185", "revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4", "source_id": "cpython-3.13:howto/sockets.rst", "uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"}] |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.