sample_id stringlengths 26 61 | family_id stringclasses 70
values | text stringlengths 141 7.87k | language stringclasses 1
value | profile stringclasses 1
value | version_context stringclasses 7
values | source_refs listlengths 1 1 |
|---|---|---|---|---|---|---|
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/7fa0ef50764... |
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/7fa0ef50... |
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/7fa0ef5... |
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/... |
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/35d85... |
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/... |
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/35d85dcce6c57fdc871f386... |
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/35d85dcce6c57fdc871f... |
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/35d85dcce6c57fdc871f... |
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/35d85dcce6c57fdc871... |
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/35d8... |
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/35d85... |
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/35... |
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/35... |
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/... |
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/... |
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/35d85dcce6c57fd... |
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/35d85dcce6c5... |
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/35d85dcce6c5... |
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/35d85dcce6c... |
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/35d85dcce6... |
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/35d85dcce6... |
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/35d85dcce6... |
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/35d85dcce6... |
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/35d85dcce6... |
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/35d85dcce6... |
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/35d85dcce6... |
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/3... |
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/0... |
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/0... |
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/f7da0350254c0ed7... |
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/f7da0350254c0... |
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/f7da0350254c0ed7c72f3e... |
dp-pt-cpython-3.13-c-api-bytes.rst-1 | dp-Python-c-api-bytes.rst | Bytes Objects
-------------
These functions raise :exc:`TypeError` when expecting a bytes parameter and
called with a non-bytes parameter.
.. index:: pair: object; bytes
.. c:type:: PyBytesObject
This subtype of :c:type:`PyObject` represents a Python bytes object.
.. c:var:: PyTypeObject PyBytes_Type
This... | en | software_docs | Python 3.13.0 | [
{
"license": "PSF-2.0",
"locator": "Python-3.13.0/Doc/c-api/bytes.rst#codepoints:37:1969",
"revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4",
"source_id": "cpython-3.13:c-api/bytes.rst",
"uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz... |
dp-pt-cpython-3.13-c-api-bytes.rst-2 | dp-Python-c-api-bytes.rst | must be C types and must correspond exactly to the format characters in the
*format* string. The following format characters are allowed:
.. % XXX: This should be exactly the same as the table in PyErr_Format.
.. % One should just refer to the other.
.. tabularcolumns:: |l|l|L|
+------------------... | en | software_docs | Python 3.13.0 | [
{
"license": "PSF-2.0",
"locator": "Python-3.13.0/Doc/c-api/bytes.rst#codepoints:1703:9167",
"revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4",
"source_id": "cpython-3.13:c-api/bytes.rst",
"uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.t... |
dp-pt-cpython-3.12-c-api-bytes.rst-2 | dp-Python-c-api-bytes.rst | must be C types and must correspond exactly to the format characters in the
*format* string. The following format characters are allowed:
.. % XXX: This should be exactly the same as the table in PyErr_Format.
.. % One should just refer to the other.
.. tabularcolumns:: |l|l|L|
+------------------... | en | software_docs | Python 3.12.7 | [
{
"license": "PSF-2.0",
"locator": "Python-3.12.7/Doc/c-api/bytes.rst#codepoints:1703:9271",
"revision": "3.12.7+sha256:73ac8fe780227bf371add8373c3079f42a0dc62deff8d612cd15a618082ab623",
"source_id": "cpython-3.12:c-api/bytes.rst",
"uri": "https://www.python.org/ftp/python/3.12.7/Python-3.12.7.t... |
dp-pt-cpython-3.13-c-api-call.rst-0 | dp-Python-c-api-call.rst | .. highlight:: c
.. _call:
Call Protocol
=============
CPython supports two different calling protocols:
*tp_call* and vectorcall.
The *tp_call* Protocol
----------------------
Instances of classes that set :c:member:`~PyTypeObject.tp_call` are callable.
The signature of the slot is::
PyObject *tp_call(PyObje... | en | software_docs | Python 3.13.0 | [
{
"license": "PSF-2.0",
"locator": "Python-3.13.0/Doc/c-api/call.rst#codepoints:0:914",
"revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4",
"source_id": "cpython-3.13:c-api/call.rst",
"uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"
... |
dp-pt-cpython-3.13-c-api-call.rst-1 | dp-Python-c-api-call.rst | The Vectorcall Protocol
-----------------------
.. versionadded:: 3.9
The vectorcall protocol was introduced in :pep:`590` as an additional protocol
for making calls more efficient.
As rule of thumb, CPython will prefer the vectorcall for internal calls
if the callable supports it. However, this is not a hard rule.
... | en | software_docs | Python 3.13.0 | [
{
"license": "PSF-2.0",
"locator": "Python-3.13.0/Doc/c-api/call.rst#codepoints:914:4532",
"revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4",
"source_id": "cpython-3.13:c-api/call.rst",
"uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"... |
dp-pt-cpython-3.13-c-api-call.rst-2 | dp-Python-c-api-call.rst | Recursion Control
.................
When using *tp_call*, callees do not need to worry about
:ref:`recursion <recursion>`: CPython uses
:c:func:`Py_EnterRecursiveCall` and :c:func:`Py_LeaveRecursiveCall`
for calls made using *tp_call*.
For efficiency, this is not the case for calls done using vectorcall:
the callee s... | en | software_docs | Python 3.13.0 | [
{
"license": "PSF-2.0",
"locator": "Python-3.13.0/Doc/c-api/call.rst#codepoints:4532:6375",
"revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4",
"source_id": "cpython-3.13:c-api/call.rst",
"uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz... |
dp-pt-cpython-3.13-c-api-call.rst-3 | dp-Python-c-api-call.rst | Object Calling API
------------------
Various functions are available for calling a Python object.
Each converts its arguments to a convention supported by the called object –
either *tp_call* or vectorcall.
In order to do as little conversion as possible, pick one that best fits
the format of data you have available.... | en | software_docs | Python 3.13.0 | [
{
"license": "PSF-2.0",
"locator": "Python-3.13.0/Doc/c-api/call.rst#codepoints:6375:10369",
"revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4",
"source_id": "cpython-3.13:c-api/call.rst",
"uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tg... |
dp-pt-cpython-3.13-c-api-call.rst-4 | dp-Python-c-api-call.rst |
Return the result of the call on success, or raise an exception and return
*NULL* on failure.
This is the equivalent of the Python expression:
``callable(*args, **kwargs)``.
.. c:function:: PyObject* PyObject_CallNoArgs(PyObject *callable)
Call a callable Python object *callable* without any argumen... | en | software_docs | Python 3.13.0 | [
{
"license": "PSF-2.0",
"locator": "Python-3.13.0/Doc/c-api/call.rst#codepoints:10112:16675",
"revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4",
"source_id": "cpython-3.13:c-api/call.rst",
"uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.t... |
dp-pt-cpython-3.13-c-api-call.rst-5 | dp-Python-c-api-call.rst | Call Support API
----------------
.. c:function:: int PyCallable_Check(PyObject *o)
Determine if the object *o* is callable. Return ``1`` if the object is callable
and ``0`` otherwise. This function always succeeds.
| en | software_docs | Python 3.13.0 | [
{
"license": "PSF-2.0",
"locator": "Python-3.13.0/Doc/c-api/call.rst#codepoints:16675:16901",
"revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4",
"source_id": "cpython-3.13:c-api/call.rst",
"uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.t... |
dp-pt-cpython-3.12-c-api-call.rst-1 | dp-Python-c-api-call.rst | The Vectorcall Protocol
-----------------------
.. versionadded:: 3.9
The vectorcall protocol was introduced in :pep:`590` as an additional protocol
for making calls more efficient.
As rule of thumb, CPython will prefer the vectorcall for internal calls
if the callable supports it. However, this is not a hard rule.
... | en | software_docs | Python 3.12.7 | [
{
"license": "PSF-2.0",
"locator": "Python-3.12.7/Doc/c-api/call.rst#codepoints:914:5071",
"revision": "3.12.7+sha256:73ac8fe780227bf371add8373c3079f42a0dc62deff8d612cd15a618082ab623",
"source_id": "cpython-3.12:c-api/call.rst",
"uri": "https://www.python.org/ftp/python/3.12.7/Python-3.12.7.tgz"... |
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.t... |
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-init.rst-0 | dp-Python-c-api-init.rst | .. highlight:: c
.. _initialization:
*****************************************
Initialization, Finalization, and Threads
*****************************************
See also :ref:`Python Initialization Configuration <init-config>`.
.. _pre-init-safe:
Before Python Initialization
============================
In an ... | en | software_docs | Python 3.13.0 | [
{
"license": "PSF-2.0",
"locator": "Python-3.13.0/Doc/c-api/init.rst#codepoints:0:1880",
"revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4",
"source_id": "cpython-3.13:c-api/init.rst",
"uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz"
... |
dp-pt-cpython-3.13-c-api-init.rst-1 | dp-Python-c-api-init.rst | Global configuration variables
==============================
Python has variables for the global configuration to control different features
and options. By default, these flags are controlled by :ref:`command line
options <using-on-interface-options>`.
When a flag is set by an option, the value of the flag is the n... | en | software_docs | Python 3.13.0 | [
{
"license": "PSF-2.0",
"locator": "Python-3.13.0/Doc/c-api/init.rst#codepoints:1880:5720",
"revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4",
"source_id": "cpython-3.13:c-api/init.rst",
"uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tgz... |
dp-pt-cpython-3.13-c-api-init.rst-2 | dp-Python-c-api-init.rst | :data:`sys.stdin` does not appear to be a terminal.
Set by the :option:`-i` option and the :envvar:`PYTHONINSPECT` environment
variable.
.. deprecated-removed:: 3.12 3.14
.. c:var:: int Py_InteractiveFlag
This API is kept for backward compatibility: setting
:c:member:`PyConfig.interactive` should ... | en | software_docs | Python 3.13.0 | [
{
"license": "PSF-2.0",
"locator": "Python-3.13.0/Doc/c-api/init.rst#codepoints:5499:10516",
"revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4",
"source_id": "cpython-3.13:c-api/init.rst",
"uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.tg... |
dp-pt-cpython-3.13-c-api-init.rst-3 | dp-Python-c-api-init.rst | Initializing and finalizing the interpreter
===========================================
.. c:function:: void Py_Initialize()
.. index::
single: PyEval_InitThreads()
single: modules (in module sys)
single: path (in module sys)
pair: module; builtins
pair: module; __main__
pair: ... | en | software_docs | Python 3.13.0 | [
{
"license": "PSF-2.0",
"locator": "Python-3.13.0/Doc/c-api/init.rst#codepoints:10516:15281",
"revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4",
"source_id": "cpython-3.13:c-api/init.rst",
"uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.t... |
dp-pt-cpython-3.13-c-api-init.rst-4 | dp-Python-c-api-init.rst | Process-wide parameters
=======================
.. c:function:: void Py_SetProgramName(const wchar_t *name)
.. index::
single: Py_Initialize()
single: main()
single: Py_GetPath()
This API is kept for backward compatibility: setting
:c:member:`PyConfig.program_name` should be used instead,... | en | software_docs | Python 3.13.0 | [
{
"license": "PSF-2.0",
"locator": "Python-3.13.0/Doc/c-api/init.rst#codepoints:15281:19167",
"revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4",
"source_id": "cpython-3.13:c-api/init.rst",
"uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.t... |
dp-pt-cpython-3.13-c-api-init.rst-5 | dp-Python-c-api-init.rst | files (such as executables and shared libraries) are installed in a different
directory tree. In a typical installation, platform dependent files may be
installed in the :file:`/usr/local/plat` subtree while platform independent may
be installed in :file:`/usr/local`.
Generally speaking, a platform is ... | en | software_docs | Python 3.13.0 | [
{
"license": "PSF-2.0",
"locator": "Python-3.13.0/Doc/c-api/init.rst#codepoints:18884:22874",
"revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4",
"source_id": "cpython-3.13:c-api/init.rst",
"uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.t... |
dp-pt-cpython-3.13-c-api-init.rst-6 | dp-Python-c-api-init.rst | the first characters are the major and minor version separated by a
period. The returned string points into static storage; the caller should not
modify its value. The value is available to Python code as :data:`sys.version`.
See also the :c:var:`Py_Version` constant.
.. c:function:: const char* Py_Get... | en | software_docs | Python 3.13.0 | [
{
"license": "PSF-2.0",
"locator": "Python-3.13.0/Doc/c-api/init.rst#codepoints:22636:29384",
"revision": "3.13.0+sha256:12445c7b3db3126c41190bfdc1c8239c39c719404e844babbd015a1bc3fafcd4",
"source_id": "cpython-3.13:c-api/init.rst",
"uri": "https://www.python.org/ftp/python/3.13.0/Python-3.13.0.t... |
Python Library Documentation Corpus for RAG & Continued Pretraining (Version-Aware)
Release name: MatrixNorm DomainPacks software_docs v1 (free sample)
Version-aware software documentation for continued pretraining and retrieval: the official docs of Python 3.13 and 3.12, Flask, Click, Jinja, Werkzeug and attrs, read from sha256-pinned release archives, normalized, split into heading-scoped chunks that keep code blocks whole, and de-duplicated across versions (3.12 keeps only the text that differs from 3.13). Each pretraining row carries its version context and the exact archive and character range it came from. Retrieval rows ask about a specific API symbol or section in a specific version, with the exact supporting chunk as the positive, same-document hard negatives that never mention the target, and unanswerable queries for plausible API names that exist nowhere in that project's docs.
This is the free public sample: whole train groups only (about 10% of them). Validation and test rows stay in the private full release so they remain unseen. Splits below are therefore train only.
Rows
| View | train |
|---|---|
domain_pretraining |
453 |
domain_retrieval |
452 |
from datasets import load_dataset
ds = load_dataset("williamTLmiller/matrixnorm-domainpacks-software-docs-v1-sample", "domain_pretraining")
Each view is also stored as JSON Lines next to the Parquet file, with identical rows. Nested fields (messages, citations, source_refs, tables) are native lists and structs in both.
Views. domain_pretraining: text (an exact slice of the normalized source file), language, profile, version_context (for example Python 3.13.0) and source_refs (archive URL, version plus archive sha256, license, and path#codepoints:start:end). domain_retrieval: query, positives, hard_negatives and answerability (answerable or unanswerable). For RAG evaluation, an unanswerable query has no positive, and the hard negative is the closest real passage, which does not answer it.
How it was built
Sources are pinned by exact release-archive URL and sha256 (python.org and PyPI release files). Only the documentation directory of each archive is read, as text; nothing is executed. Python code examples are syntax-checked with ast.parse and recorded as pass or fail; they are never run. Chunks target 4,000 characters (maximum 8,000) with 300-character overlap when a long section must be split, and splits only fall on blank lines outside literal blocks, code blocks and tables. A section that cannot be split under the maximum is quarantined, never truncated. Exact duplicates (after whitespace normalization) keep the newest version. Groups = the same doc path across versions, merged with any documents that share a duplicate chunk, so the same text never lands on both sides of a split. Token counts use a pinned GPT-2-style pre-tokenizer regex (matrixnorm-pretok-regex-v1), not a learned vocabulary.
Validation
Every record is checked before it is written: schema, cross-references, split membership, and the dataset-specific checks described above. A family that fails any check is quarantined as a whole, never silently dropped or partially kept.
Build stats: {"chunks_exclude": 2512, "chunks_include": 4408, "chunks_quarantine": 28, "documents": 1156, "examples_not_run": 1049, "examples_syntax_fail": 1506, "examples_syntax_pass": 8380, "symbols": 17525}
Trainability baseline
Measured on the full release's held-out splits (this sample is train only). TF-IDF retrieval (vectorizer fit on train pretraining text only), ranking each held-out query against that split's pooled positives and hard negatives:
| Split | Answerable queries | Pool | Recall@1 | Recall@5 | MRR | Random Recall@5 |
|---|---|---|---|---|---|---|
| validation | 44 | 30 | 0.250 | 0.523 | 0.374 | 0.167 |
| test | 31 | 29 | 0.484 | 0.613 | 0.563 | 0.172 |
The held-out sets are small (see the pilot note above), so treat these as a sanity check that the pairs are learnable, not as a benchmark.
Limitations
- Seven documentation trees only; Python dominates the token count. Retrieval positives come from the symbol's own directive or section, so paraphrased or multi-hop questions are not covered.
- reStructuredText and MyST markup is kept as written (it is the source text); strip it if you need plain prose.
- Python 3.12 rows are only the chunks whose text differs from 3.13.
Licensing
CC BY-NC 4.0 (see LICENSE and NOTICE). The license covers only the MatrixNorm packaging layer; the documentation text keeps its own PSF-2.0 / BSD-3-Clause / MIT license, copied in source-license-copies/. Commercial licensing: energea@energeatech.com.
Citation
MatrixNorm DomainPacks software_docs v1. williamTLmiller, MatrixNorm, 2026. https://huggingface.co/datasets/williamTLmiller/matrixnorm-domainpacks-software-docs-v1-sample
- Downloads last month
- 54