iSharkFly-Open
/
python-peps
mirror of https://github.com/python/peps.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

PEP 381: Resolve uses of the default role (#3375)

This commit is contained in:
Adam Turner 2023-09-01 20:19:20 +01:00 committed by GitHub
parent 2ea7e87926
commit ea13fde512
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
pep-0381.txt
View File

@ -37,8 +37,8 @@ Rationale
========= =========
PyPI is hosting over 6000 projects and is used on a daily basis PyPI is hosting over 6000 projects and is used on a daily basis
by people to build applications. Especially systems like `easy_install` by people to build applications. Especially systems like ``easy_install``
and `zc.buildout` make intensive usage of PyPI. and ``zc.buildout`` make intensive usage of PyPI.
For people making intensive use of PyPI, it can act as a single point For people making intensive use of PyPI, it can act as a single point
of failure. People have started to set up some mirrors, both private of failure. People have started to set up some mirrors, both private
@ -74,19 +74,19 @@ last host name. Mirror operators should use a static address,
and report planned changes to that address in advance to and report planned changes to that address in advance to
distutils-sig. distutils-sig.
The new mirror also appears at `http://pypi.python.org/mirrors` The new mirror also appears at ``http://pypi.python.org/mirrors``
which is a human-readable page that gives the list of mirrors. which is a human-readable page that gives the list of mirrors.
This page also explains how to register a new mirror. This page also explains how to register a new mirror.
Statistics page Statistics page
::::::::::::::: :::::::::::::::
PyPI provides statistics on downloads at `/stats`. This page is PyPI provides statistics on downloads at ``/stats``. This page is
calculated daily by PyPI, by reading all mirrors' local stats and calculated daily by PyPI, by reading all mirrors' local stats and
summing them. summing them.
The stats are presented in daily or monthly files, under `/stats/days` The stats are presented in daily or monthly files, under ``/stats/days``
and `/stats/months`. Each file is a `bzip2` file with these formats: and ``/stats/months``. Each file is a ``bzip2`` file with these formats:
- YYYY-MM-DD.bz2 for daily files - YYYY-MM-DD.bz2 for daily files
- YYYY-MM.bz2 for monthly files - YYYY-MM.bz2 for monthly files
@ -180,7 +180,7 @@ that represents the last synchronisation date the mirror maintains.
The date is provided in GMT time, using the ISO 8601 format [#iso8601]_. The date is provided in GMT time, using the ISO 8601 format [#iso8601]_.
Each mirror will be responsible to maintain its last modified date. Each mirror will be responsible to maintain its last modified date.
This page must be located at : `/last-modified` and must be a This page must be located at : ``/last-modified`` and must be a
text/plain page. text/plain page.
Local statistics Local statistics
@ -192,7 +192,7 @@ display the grand total.
These statistics are in CSV-like form, with a header in the first These statistics are in CSV-like form, with a header in the first
line. It needs to obey :pep:`305`. Basically, it should be line. It needs to obey :pep:`305`. Basically, it should be
readable by Python's `csv` module. readable by Python's ``csv`` module.
The fields in this file are: The fields in this file are:
@ -209,26 +209,26 @@ The content will look like this::
... ...
The counting starts the day the mirror is launched, and there is one The counting starts the day the mirror is launched, and there is one
file per day, compressed using the `bzip2` format. Each file is named file per day, compressed using the ``bzip2`` format. Each file is named
like the day. For example, `2008-11-06.bz2` is the file for the 6th of like the day. For example, ``2008-11-06.bz2`` is the file for the 6th of
November 2008. November 2008.
They are then provided in a folder called `days`. For example: They are then provided in a folder called ``days``. For example:
- /local-stats/days/2008-11-06.bz2 - /local-stats/days/2008-11-06.bz2
- /local-stats/days/2008-11-07.bz2 - /local-stats/days/2008-11-07.bz2
- /local-stats/days/2008-11-08.bz2 - /local-stats/days/2008-11-08.bz2
This page must be located at `/local-stats`. This page must be located at ``/local-stats``.
How a mirror should synchronize with PyPI How a mirror should synchronize with PyPI
========================================= =========================================
A mirroring protocol called `Simple Index` was described and A mirroring protocol called ``Simple Index`` was described and
implemented by Martin v. Loewis and Jim Fulton, based on how implemented by Martin v. Loewis and Jim Fulton, based on how
`easy_install` works. This section synthesizes it and gives a few ``easy_install`` works. This section synthesizes it and gives a few
relevant links, plus a small part about `User-Agent`. relevant links, plus a small part about ``User-Agent``.
The mirroring protocol The mirroring protocol
:::::::::::::::::::::: ::::::::::::::::::::::
@ -267,7 +267,7 @@ How a client can use PyPI and its mirrors
::::::::::::::::::::::::::::::::::::::::: :::::::::::::::::::::::::::::::::::::::::
Clients that are browsing PyPI should be able to use alternative Clients that are browsing PyPI should be able to use alternative
mirrors, by getting the list of the mirrors using `last.pypi.python.org`. mirrors, by getting the list of the mirrors using ``last.pypi.python.org``.
Code example:: Code example::
@ -309,7 +309,7 @@ runs their own server where people might get the project package.
However, it is strongly encouraged that a public package index follows However, it is strongly encouraged that a public package index follows
PyPI and Distutils protocols. PyPI and Distutils protocols.
In other words, the `register` and `upload` command should be In other words, the ``register`` and ``upload`` command should be
compatible with any package index server out there. compatible with any package index server out there.
Software that are compatible with PyPI and Distutils so far: Software that are compatible with PyPI and Distutils so far: