Start translation to pt-br: Basic structure, contexts.rst, index.rst and getting-started.rst
This commit is contained in:
Joao Pedro Marcolino Cordeiro
parent
9e1804a6ee
commit
d6f3aef9ea
|
|
@ -0,0 +1,43 @@
|
||||||
|
# Minimal makefile for Sphinx documentation
|
||||||
|
#
|
||||||
|
|
||||||
|
# You can set these variables from the command line, and also
|
||||||
|
# from the environment for the first two.
|
||||||
|
SPHINXOPTS ?=
|
||||||
|
SPHINXBUILD ?= sphinx-build
|
||||||
|
SOURCEDIR = .
|
||||||
|
BUILDDIR = _build
|
||||||
|
|
||||||
|
# Put it first so that "make" without argument is like "make help".
|
||||||
|
help:
|
||||||
|
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||||
|
|
||||||
|
.PHONY: help Makefile
|
||||||
|
|
||||||
|
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||||
|
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||||
|
%: Makefile
|
||||||
|
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||||
|
|
||||||
|
|
||||||
|
REGENDOC_ARGS := \
|
||||||
|
--normalize "/[ \t]+\n/\n/" \
|
||||||
|
--normalize "~\$$REGENDOC_TMPDIR~/home/sweet/project~" \
|
||||||
|
--normalize "~/path/to/example~/home/sweet/project~" \
|
||||||
|
--normalize "/in \d.\d\ds/in 0.12s/" \
|
||||||
|
--normalize "@/tmp/pytest-of-.*/pytest-\d+@PYTEST_TMPDIR@" \
|
||||||
|
--normalize "@pytest-(\d+)\\.[^ ,]+@pytest-\1.x.y@" \
|
||||||
|
--normalize "@py-(\d+)\\.[^ ,]+@py-\1.x.y@" \
|
||||||
|
--normalize "@pluggy-(\d+)\\.[.\d,]+@pluggy-\1.x.y@" \
|
||||||
|
--normalize "@hypothesis-(\d+)\\.[.\d,]+@hypothesis-\1.x.y@" \
|
||||||
|
--normalize "@Python (\d+)\\.[^ ,]+@Python \1.x.y@"
|
||||||
|
|
||||||
|
regen: REGENDOC_FILES:=*.rst */*.rst
|
||||||
|
regen:
|
||||||
|
# need to reset cachedir to the non-tox default
|
||||||
|
PYTHONDONTWRITEBYTECODE=1 \
|
||||||
|
PYTEST_ADDOPTS="-pno:hypothesis -p no:hypothesispytest -Wignore::pytest.PytestUnknownMarkWarning -o cache_dir=.pytest_cache" \
|
||||||
|
COLUMNS=76 \
|
||||||
|
regendoc --update ${REGENDOC_FILES} ${REGENDOC_ARGS}
|
||||||
|
|
||||||
|
.PHONY: regen
|
||||||
|
|
@ -0,0 +1,31 @@
|
||||||
|
<h3>Contents</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="{{ pathto('index') }}">Home</a></li>
|
||||||
|
|
||||||
|
<li><a href="{{ pathto('getting-started') }}">Get started</a></li>
|
||||||
|
<li><a href="{{ pathto('how-to/index') }}">How-to guides</a></li>
|
||||||
|
<li><a href="{{ pathto('reference/index') }}">Reference guides</a></li>
|
||||||
|
<li><a href="{{ pathto('explanation/index') }}">Explanation</a></li>
|
||||||
|
<li><a href="{{ pathto('contents') }}">Complete table of contents</a></li>
|
||||||
|
<li><a href="{{ pathto('example/index') }}">Library of examples</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>About the project</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="{{ pathto('changelog') }}">Changelog</a></li>
|
||||||
|
<li><a href="{{ pathto('contributing') }}">Contributing</a></li>
|
||||||
|
<li><a href="{{ pathto('backwards-compatibility') }}">Backwards Compatibility</a></li>
|
||||||
|
<li><a href="{{ pathto('sponsor') }}">Sponsor</a></li>
|
||||||
|
<li><a href="{{ pathto('tidelift') }}">pytest for Enterprise</a></li>
|
||||||
|
<li><a href="{{ pathto('license') }}">License</a></li>
|
||||||
|
<li><a href="{{ pathto('contact') }}">Contact Channels</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
{%- if display_toc %}
|
||||||
|
<hr>
|
||||||
|
{{ toc }}
|
||||||
|
{%- endif %}
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
|
@ -0,0 +1,52 @@
|
||||||
|
{#
|
||||||
|
|
||||||
|
Copied from:
|
||||||
|
|
||||||
|
https://raw.githubusercontent.com/pallets/pallets-sphinx-themes/b0c6c41849b4e15cbf62cc1d95c05ef2b3e155c8/src/pallets_sphinx_themes/themes/pocoo/layout.html
|
||||||
|
|
||||||
|
And removed the warning version (see #7331).
|
||||||
|
|
||||||
|
#}
|
||||||
|
|
||||||
|
{% extends "basic/layout.html" %}
|
||||||
|
|
||||||
|
{% set metatags %}
|
||||||
|
{{- metatags }}
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||||
|
{%- endset %}
|
||||||
|
|
||||||
|
{% block extrahead %}
|
||||||
|
{%- if page_canonical_url %}
|
||||||
|
<link rel="canonical" href="{{ page_canonical_url }}">
|
||||||
|
{%- endif %}
|
||||||
|
<script>DOCUMENTATION_OPTIONS.URL_ROOT = '{{ url_root }}';</script>
|
||||||
|
{{ super() }}
|
||||||
|
{%- endblock %}
|
||||||
|
|
||||||
|
{% block sidebarlogo %}
|
||||||
|
{% if pagename != "index" or theme_index_sidebar_logo %}
|
||||||
|
{{ super() }}
|
||||||
|
{% endif %}
|
||||||
|
{% endblock %}
|
||||||
|
|
||||||
|
{% block relbar2 %}{% endblock %}
|
||||||
|
|
||||||
|
{% block sidebar2 %}
|
||||||
|
<span id="sidebar-top"></span>
|
||||||
|
{{- super() }}
|
||||||
|
{%- endblock %}
|
||||||
|
|
||||||
|
{% block footer %}
|
||||||
|
{{ super() }}
|
||||||
|
{%- if READTHEDOCS and not readthedocs_docsearch %}
|
||||||
|
<script>
|
||||||
|
if (typeof READTHEDOCS_DATA !== 'undefined') {
|
||||||
|
if (!READTHEDOCS_DATA.features) {
|
||||||
|
READTHEDOCS_DATA.features = {};
|
||||||
|
}
|
||||||
|
READTHEDOCS_DATA.features.docsearch_disabled = true;
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
{%- endif %}
|
||||||
|
{{ js_tag("_static/version_warning_offset.js") }}
|
||||||
|
{% endblock %}
|
||||||
|
|
@ -0,0 +1,7 @@
|
||||||
|
<h3>Useful Links</h3>
|
||||||
|
<ul>
|
||||||
|
<li><a href="https://pypi.org/project/pytest/">pytest @ PyPI</a></li>
|
||||||
|
<li><a href="https://github.com/pytest-dev/pytest/">pytest @ GitHub</a></li>
|
||||||
|
<li><a href="https://github.com/pytest-dev/pytest/issues">Issue Tracker</a></li>
|
||||||
|
<li><a href="https://media.readthedocs.org/pdf/pytest/latest/pytest.pdf">PDF Documentation</a>
|
||||||
|
</ul>
|
||||||
|
|
@ -0,0 +1,19 @@
|
||||||
|
<h3>Related Topics</h3>
|
||||||
|
<ul>
|
||||||
|
<li><a href="{{ pathto(master_doc) }}">Documentation overview</a><ul>
|
||||||
|
{%- for parent in parents %}
|
||||||
|
<li><a href="{{ parent.link|e }}">{{ parent.title }}</a><ul>
|
||||||
|
{%- endfor %}
|
||||||
|
{%- if prev %}
|
||||||
|
<li>Previous: <a href="{{ prev.link|e }}" title="{{ _('previous chapter')
|
||||||
|
}}">{{ prev.title }}</a></li>
|
||||||
|
{%- endif %}
|
||||||
|
{%- if next %}
|
||||||
|
<li>Next: <a href="{{ next.link|e }}" title="{{ _('next chapter')
|
||||||
|
}}">{{ next.title }}</a></li>
|
||||||
|
{%- endif %}
|
||||||
|
{%- for parent in parents %}
|
||||||
|
</ul></li>
|
||||||
|
{%- endfor %}
|
||||||
|
</ul></li>
|
||||||
|
</ul>
|
||||||
|
|
@ -0,0 +1,5 @@
|
||||||
|
<h3>About pytest</h3>
|
||||||
|
<p>
|
||||||
|
pytest is a mature full-featured Python testing tool that helps
|
||||||
|
you write better programs.
|
||||||
|
</p>
|
||||||
|
|
@ -0,0 +1,15 @@
|
||||||
|
{#
|
||||||
|
basic/searchbox.html with heading removed.
|
||||||
|
#}
|
||||||
|
{%- if pagename != "search" and builder != "singlehtml" %}
|
||||||
|
<div id="searchbox" style="display: none" role="search">
|
||||||
|
<div class="searchformwrapper">
|
||||||
|
<form class="search" action="{{ pathto('search') }}" method="get">
|
||||||
|
<input type="text" name="q" aria-labelledby="searchlabel"
|
||||||
|
placeholder="Search"/>
|
||||||
|
<input type="submit" value="{{ _('Go') }}" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||||
|
{%- endif %}
|
||||||
|
|
@ -0,0 +1,475 @@
|
||||||
|
#
|
||||||
|
# pytest documentation build configuration file, created by
|
||||||
|
# sphinx-quickstart on Fri Oct 8 17:54:28 2010.
|
||||||
|
#
|
||||||
|
# This file is execfile()d with the current directory set to its containing dir.
|
||||||
|
#
|
||||||
|
# Note that not all possible configuration values are present in this
|
||||||
|
# autogenerated file.
|
||||||
|
#
|
||||||
|
# All configuration values have a default; values that are commented out
|
||||||
|
# serve to show the default.
|
||||||
|
# The version info for the project you're documenting, acts as replacement for
|
||||||
|
# |version| and |release|, also used in various other places throughout the
|
||||||
|
# built documents.
|
||||||
|
#
|
||||||
|
# The full version, including alpha/beta/rc tags.
|
||||||
|
# The short X.Y version.
|
||||||
|
import ast
|
||||||
|
import os
|
||||||
|
import shutil
|
||||||
|
import sys
|
||||||
|
from textwrap import dedent
|
||||||
|
from typing import List
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
from _pytest import __version__ as version
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
import sphinx.application
|
||||||
|
|
||||||
|
|
||||||
|
release = ".".join(version.split(".")[:2])
|
||||||
|
|
||||||
|
# If extensions (or modules to document with autodoc) are in another directory,
|
||||||
|
# add these directories to sys.path here. If the directory is relative to the
|
||||||
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||||
|
# sys.path.insert(0, os.path.abspath('.'))
|
||||||
|
|
||||||
|
autodoc_member_order = "bysource"
|
||||||
|
autodoc_typehints = "description"
|
||||||
|
autodoc_typehints_description_target = "documented"
|
||||||
|
todo_include_todos = 1
|
||||||
|
|
||||||
|
latex_engine = "lualatex"
|
||||||
|
|
||||||
|
latex_elements = {
|
||||||
|
"preamble": dedent(
|
||||||
|
r"""
|
||||||
|
\directlua{
|
||||||
|
luaotfload.add_fallback("fallbacks", {
|
||||||
|
"Noto Serif CJK SC:style=Regular;",
|
||||||
|
"Symbola:Style=Regular;"
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
\setmainfont{FreeSerif}[RawFeature={fallback=fallbacks}]
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
# -- General configuration -----------------------------------------------------
|
||||||
|
|
||||||
|
# If your documentation needs a minimal Sphinx version, state it here.
|
||||||
|
# needs_sphinx = '1.0'
|
||||||
|
|
||||||
|
# Add any Sphinx extension module names here, as strings. They can be extensions
|
||||||
|
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||||
|
extensions = [
|
||||||
|
"pallets_sphinx_themes",
|
||||||
|
"pygments_pytest",
|
||||||
|
"sphinx.ext.autodoc",
|
||||||
|
"sphinx.ext.autosummary",
|
||||||
|
"sphinx.ext.extlinks",
|
||||||
|
"sphinx.ext.intersphinx",
|
||||||
|
"sphinx.ext.todo",
|
||||||
|
"sphinx.ext.viewcode",
|
||||||
|
"sphinx_removed_in",
|
||||||
|
"sphinxcontrib_trio",
|
||||||
|
]
|
||||||
|
|
||||||
|
# Building PDF docs on readthedocs requires inkscape for svg to pdf
|
||||||
|
# conversion. The relevant plugin is not useful for normal HTML builds, but
|
||||||
|
# it still raises warnings and fails CI if inkscape is not available. So
|
||||||
|
# only use the plugin if inkscape is actually available.
|
||||||
|
if shutil.which("inkscape"):
|
||||||
|
extensions.append("sphinxcontrib.inkscapeconverter")
|
||||||
|
|
||||||
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
|
templates_path = ["_templates"]
|
||||||
|
|
||||||
|
# The suffix of source filenames.
|
||||||
|
source_suffix = ".rst"
|
||||||
|
|
||||||
|
# The encoding of source files.
|
||||||
|
# source_encoding = 'utf-8-sig'
|
||||||
|
|
||||||
|
# The master toctree document.
|
||||||
|
master_doc = "contents"
|
||||||
|
|
||||||
|
# General information about the project.
|
||||||
|
project = "pytest"
|
||||||
|
copyright = "2015, holger krekel and pytest-dev team"
|
||||||
|
|
||||||
|
|
||||||
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
|
# for a list of supported languages.
|
||||||
|
# language = None
|
||||||
|
|
||||||
|
# There are two options for replacing |today|: either, you set today to some
|
||||||
|
# non-false value, then it is used:
|
||||||
|
# today = ''
|
||||||
|
# Else, today_fmt is used as the format for a strftime call.
|
||||||
|
# today_fmt = '%B %d, %Y'
|
||||||
|
|
||||||
|
# List of patterns, relative to source directory, that match files and
|
||||||
|
# directories to ignore when looking for source files.
|
||||||
|
exclude_patterns = [
|
||||||
|
"_build",
|
||||||
|
"naming20.rst",
|
||||||
|
"test/*",
|
||||||
|
"old_*",
|
||||||
|
"*attic*",
|
||||||
|
"*/attic*",
|
||||||
|
"funcargs.rst",
|
||||||
|
"setup.rst",
|
||||||
|
"example/remoteinterp.rst",
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
# The reST default role (used for this markup: `text`) to use for all documents.
|
||||||
|
default_role = "literal"
|
||||||
|
|
||||||
|
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||||
|
# add_function_parentheses = True
|
||||||
|
|
||||||
|
# If true, the current module name will be prepended to all description
|
||||||
|
# unit titles (such as .. function::).
|
||||||
|
add_module_names = False
|
||||||
|
|
||||||
|
# If true, sectionauthor and moduleauthor directives will be shown in the
|
||||||
|
# output. They are ignored by default.
|
||||||
|
# show_authors = False
|
||||||
|
|
||||||
|
# The name of the Pygments (syntax highlighting) style to use.
|
||||||
|
pygments_style = "sphinx"
|
||||||
|
|
||||||
|
|
||||||
|
# A list of ignored prefixes for module index sorting.
|
||||||
|
# modindex_common_prefix = []
|
||||||
|
|
||||||
|
# A list of regular expressions that match URIs that should not be checked when
|
||||||
|
# doing a linkcheck.
|
||||||
|
linkcheck_ignore = [
|
||||||
|
"https://blogs.msdn.microsoft.com/bharry/2017/06/28/testing-in-a-cloud-delivery-cadence/",
|
||||||
|
"http://pythontesting.net/framework/pytest-introduction/",
|
||||||
|
r"https://github.com/pytest-dev/pytest/issues/\d+",
|
||||||
|
r"https://github.com/pytest-dev/pytest/pull/\d+",
|
||||||
|
]
|
||||||
|
|
||||||
|
# The number of worker threads to use when checking links (default=5).
|
||||||
|
linkcheck_workers = 5
|
||||||
|
|
||||||
|
|
||||||
|
_repo = "https://github.com/pytest-dev/pytest"
|
||||||
|
extlinks = {
|
||||||
|
"bpo": ("https://bugs.python.org/issue%s", "bpo-%s"),
|
||||||
|
"pypi": ("https://pypi.org/project/%s/", "%s"),
|
||||||
|
"issue": (f"{_repo}/issues/%s", "issue #%s"),
|
||||||
|
"pull": (f"{_repo}/pull/%s", "pull request #%s"),
|
||||||
|
"user": ("https://github.com/%s", "@%s"),
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
# -- Options for HTML output ---------------------------------------------------
|
||||||
|
|
||||||
|
sys.path.append(os.path.abspath("_themes"))
|
||||||
|
html_theme_path = ["_themes"]
|
||||||
|
|
||||||
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||||
|
# a list of builtin themes.
|
||||||
|
html_theme = "flask"
|
||||||
|
|
||||||
|
# Theme options are theme-specific and customize the look and feel of a theme
|
||||||
|
# further. For a list of options available for each theme, see the
|
||||||
|
# documentation.
|
||||||
|
# html_theme_options = {"index_logo": None}
|
||||||
|
|
||||||
|
# Add any paths that contain custom themes here, relative to this directory.
|
||||||
|
# html_theme_path = []
|
||||||
|
|
||||||
|
# The name for this set of Sphinx documents. If None, it defaults to
|
||||||
|
# "<project> v<release> documentation".
|
||||||
|
html_title = "pytest documentation"
|
||||||
|
|
||||||
|
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||||
|
html_short_title = "pytest-%s" % release
|
||||||
|
|
||||||
|
# The name of an image file (relative to this directory) to place at the top
|
||||||
|
# of the sidebar.
|
||||||
|
html_logo = "img/pytest_logo_curves.svg"
|
||||||
|
|
||||||
|
# The name of an image file (within the static path) to use as favicon of the
|
||||||
|
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
||||||
|
# pixels large.
|
||||||
|
html_favicon = "img/favicon.png"
|
||||||
|
|
||||||
|
# Add any paths that contain custom static files (such as style sheets) here,
|
||||||
|
# relative to this directory. They are copied after the builtin static files,
|
||||||
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||||
|
# html_static_path = ['_static']
|
||||||
|
|
||||||
|
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||||
|
# using the given strftime format.
|
||||||
|
# html_last_updated_fmt = '%b %d, %Y'
|
||||||
|
|
||||||
|
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||||
|
# typographically correct entities.
|
||||||
|
# html_use_smartypants = True
|
||||||
|
|
||||||
|
# Custom sidebar templates, maps document names to template names.
|
||||||
|
# html_sidebars = {}
|
||||||
|
# html_sidebars = {'index': 'indexsidebar.html'}
|
||||||
|
|
||||||
|
html_sidebars = {
|
||||||
|
"index": [
|
||||||
|
"slim_searchbox.html",
|
||||||
|
"sidebarintro.html",
|
||||||
|
"globaltoc.html",
|
||||||
|
"links.html",
|
||||||
|
"sourcelink.html",
|
||||||
|
],
|
||||||
|
"**": [
|
||||||
|
"slim_searchbox.html",
|
||||||
|
"globaltoc.html",
|
||||||
|
"relations.html",
|
||||||
|
"links.html",
|
||||||
|
"sourcelink.html",
|
||||||
|
],
|
||||||
|
}
|
||||||
|
|
||||||
|
# Additional templates that should be rendered to pages, maps page names to
|
||||||
|
# template names.
|
||||||
|
# html_additional_pages = {}
|
||||||
|
# html_additional_pages = {'index': 'index.html'}
|
||||||
|
|
||||||
|
|
||||||
|
# If false, no module index is generated.
|
||||||
|
html_domain_indices = True
|
||||||
|
|
||||||
|
# If false, no index is generated.
|
||||||
|
html_use_index = False
|
||||||
|
|
||||||
|
# If true, the index is split into individual pages for each letter.
|
||||||
|
# html_split_index = False
|
||||||
|
|
||||||
|
# If true, links to the reST sources are added to the pages.
|
||||||
|
html_show_sourcelink = False
|
||||||
|
|
||||||
|
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
||||||
|
# html_show_sphinx = True
|
||||||
|
|
||||||
|
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
||||||
|
# html_show_copyright = True
|
||||||
|
|
||||||
|
# If true, an OpenSearch description file will be output, and all pages will
|
||||||
|
# contain a <link> tag referring to it. The value of this option must be the
|
||||||
|
# base URL from which the finished HTML is served.
|
||||||
|
# html_use_opensearch = ''
|
||||||
|
|
||||||
|
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
||||||
|
# html_file_suffix = None
|
||||||
|
|
||||||
|
# Output file base name for HTML help builder.
|
||||||
|
htmlhelp_basename = "pytestdoc"
|
||||||
|
|
||||||
|
|
||||||
|
# -- Options for LaTeX output --------------------------------------------------
|
||||||
|
|
||||||
|
# The paper size ('letter' or 'a4').
|
||||||
|
# latex_paper_size = 'letter'
|
||||||
|
|
||||||
|
# The font size ('10pt', '11pt' or '12pt').
|
||||||
|
# latex_font_size = '10pt'
|
||||||
|
|
||||||
|
# Grouping the document tree into LaTeX files. List of tuples
|
||||||
|
# (source start file, target name, title, author, documentclass [howto/manual]).
|
||||||
|
latex_documents = [
|
||||||
|
(
|
||||||
|
"contents",
|
||||||
|
"pytest.tex",
|
||||||
|
"pytest Documentation",
|
||||||
|
"holger krekel, trainer and consultant, https://merlinux.eu/",
|
||||||
|
"manual",
|
||||||
|
)
|
||||||
|
]
|
||||||
|
|
||||||
|
# The name of an image file (relative to this directory) to place at the top of
|
||||||
|
# the title page.
|
||||||
|
latex_logo = "img/pytest1.png"
|
||||||
|
|
||||||
|
# For "manual" documents, if this is true, then toplevel headings are parts,
|
||||||
|
# not chapters.
|
||||||
|
# latex_use_parts = False
|
||||||
|
|
||||||
|
# If true, show page references after internal links.
|
||||||
|
# latex_show_pagerefs = False
|
||||||
|
|
||||||
|
# If true, show URL addresses after external links.
|
||||||
|
# latex_show_urls = False
|
||||||
|
|
||||||
|
# Additional stuff for the LaTeX preamble.
|
||||||
|
# latex_preamble = ''
|
||||||
|
|
||||||
|
# Documents to append as an appendix to all manuals.
|
||||||
|
# latex_appendices = []
|
||||||
|
|
||||||
|
# If false, no module index is generated.
|
||||||
|
latex_domain_indices = False
|
||||||
|
|
||||||
|
# -- Options for manual page output --------------------------------------------
|
||||||
|
|
||||||
|
# One entry per manual page. List of tuples
|
||||||
|
# (source start file, name, description, authors, manual section).
|
||||||
|
man_pages = [
|
||||||
|
("how-to/usage", "pytest", "pytest usage", ["holger krekel at merlinux eu"], 1)
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
# -- Options for Epub output ---------------------------------------------------
|
||||||
|
|
||||||
|
# Bibliographic Dublin Core info.
|
||||||
|
epub_title = "pytest"
|
||||||
|
epub_author = "holger krekel at merlinux eu"
|
||||||
|
epub_publisher = "holger krekel at merlinux eu"
|
||||||
|
epub_copyright = "2013, holger krekel et alii"
|
||||||
|
|
||||||
|
# The language of the text. It defaults to the language option
|
||||||
|
# or en if the language is not set.
|
||||||
|
# epub_language = ''
|
||||||
|
|
||||||
|
# The scheme of the identifier. Typical schemes are ISBN or URL.
|
||||||
|
# epub_scheme = ''
|
||||||
|
|
||||||
|
# The unique identifier of the text. This can be a ISBN number
|
||||||
|
# or the project homepage.
|
||||||
|
# epub_identifier = ''
|
||||||
|
|
||||||
|
# A unique identification for the text.
|
||||||
|
# epub_uid = ''
|
||||||
|
|
||||||
|
# HTML files that should be inserted before the pages created by sphinx.
|
||||||
|
# The format is a list of tuples containing the path and title.
|
||||||
|
# epub_pre_files = []
|
||||||
|
|
||||||
|
# HTML files shat should be inserted after the pages created by sphinx.
|
||||||
|
# The format is a list of tuples containing the path and title.
|
||||||
|
# epub_post_files = []
|
||||||
|
|
||||||
|
# A list of files that should not be packed into the epub file.
|
||||||
|
# epub_exclude_files = []
|
||||||
|
|
||||||
|
# The depth of the table of contents in toc.ncx.
|
||||||
|
# epub_tocdepth = 3
|
||||||
|
|
||||||
|
# Allow duplicate toc entries.
|
||||||
|
# epub_tocdup = True
|
||||||
|
|
||||||
|
|
||||||
|
# -- Options for texinfo output ------------------------------------------------
|
||||||
|
|
||||||
|
texinfo_documents = [
|
||||||
|
(
|
||||||
|
master_doc,
|
||||||
|
"pytest",
|
||||||
|
"pytest Documentation",
|
||||||
|
(
|
||||||
|
"Holger Krekel@*Benjamin Peterson@*Ronny Pfannschmidt@*"
|
||||||
|
"Floris Bruynooghe@*others"
|
||||||
|
),
|
||||||
|
"pytest",
|
||||||
|
"simple powerful testing with Python",
|
||||||
|
"Programming",
|
||||||
|
1,
|
||||||
|
)
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
intersphinx_mapping = {
|
||||||
|
"pluggy": ("https://pluggy.readthedocs.io/en/stable", None),
|
||||||
|
"python": ("https://docs.python.org/3", None),
|
||||||
|
"numpy": ("https://numpy.org/doc/stable", None),
|
||||||
|
"pip": ("https://pip.pypa.io/en/stable", None),
|
||||||
|
"tox": ("https://tox.wiki/en/stable", None),
|
||||||
|
"virtualenv": ("https://virtualenv.pypa.io/en/stable", None),
|
||||||
|
"setuptools": ("https://setuptools.pypa.io/en/stable", None),
|
||||||
|
"packaging": ("https://packaging.python.org/en/latest", None),
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def configure_logging(app: "sphinx.application.Sphinx") -> None:
|
||||||
|
"""Configure Sphinx's WarningHandler to handle (expected) missing include."""
|
||||||
|
import sphinx.util.logging
|
||||||
|
import logging
|
||||||
|
|
||||||
|
class WarnLogFilter(logging.Filter):
|
||||||
|
def filter(self, record: logging.LogRecord) -> bool:
|
||||||
|
"""Ignore warnings about missing include with "only" directive.
|
||||||
|
|
||||||
|
Ref: https://github.com/sphinx-doc/sphinx/issues/2150."""
|
||||||
|
if (
|
||||||
|
record.msg.startswith('Problems with "include" directive path:')
|
||||||
|
and "_changelog_towncrier_draft.rst" in record.msg
|
||||||
|
):
|
||||||
|
return False
|
||||||
|
return True
|
||||||
|
|
||||||
|
logger = logging.getLogger(sphinx.util.logging.NAMESPACE)
|
||||||
|
warn_handler = [x for x in logger.handlers if x.level == logging.WARNING]
|
||||||
|
assert len(warn_handler) == 1, warn_handler
|
||||||
|
warn_handler[0].filters.insert(0, WarnLogFilter())
|
||||||
|
|
||||||
|
|
||||||
|
def setup(app: "sphinx.application.Sphinx") -> None:
|
||||||
|
app.add_crossref_type(
|
||||||
|
"fixture",
|
||||||
|
"fixture",
|
||||||
|
objname="built-in fixture",
|
||||||
|
indextemplate="pair: %s; fixture",
|
||||||
|
)
|
||||||
|
|
||||||
|
app.add_object_type(
|
||||||
|
"confval",
|
||||||
|
"confval",
|
||||||
|
objname="configuration value",
|
||||||
|
indextemplate="pair: %s; configuration value",
|
||||||
|
)
|
||||||
|
|
||||||
|
app.add_object_type(
|
||||||
|
"globalvar",
|
||||||
|
"globalvar",
|
||||||
|
objname="global variable interpreted by pytest",
|
||||||
|
indextemplate="pair: %s; global variable interpreted by pytest",
|
||||||
|
)
|
||||||
|
|
||||||
|
app.add_crossref_type(
|
||||||
|
directivename="hook",
|
||||||
|
rolename="hook",
|
||||||
|
objname="pytest hook",
|
||||||
|
indextemplate="pair: %s; hook",
|
||||||
|
)
|
||||||
|
|
||||||
|
configure_logging(app)
|
||||||
|
|
||||||
|
# Make Sphinx mark classes with "final" when decorated with @final.
|
||||||
|
# We need this because we import final from pytest._compat, not from
|
||||||
|
# typing (for Python < 3.8 compat), so Sphinx doesn't detect it.
|
||||||
|
# To keep things simple we accept any `@final` decorator.
|
||||||
|
# Ref: https://github.com/pytest-dev/pytest/pull/7780
|
||||||
|
import sphinx.pycode.ast
|
||||||
|
import sphinx.pycode.parser
|
||||||
|
|
||||||
|
original_is_final = sphinx.pycode.parser.VariableCommentPicker.is_final
|
||||||
|
|
||||||
|
def patched_is_final(self, decorators: List[ast.expr]) -> bool:
|
||||||
|
if original_is_final(self, decorators):
|
||||||
|
return True
|
||||||
|
return any(
|
||||||
|
sphinx.pycode.ast.unparse(decorator) == "final" for decorator in decorators
|
||||||
|
)
|
||||||
|
|
||||||
|
sphinx.pycode.parser.VariableCommentPicker.is_final = patched_is_final
|
||||||
|
|
||||||
|
# legacypath.py monkey-patches pytest.Testdir in. Import the file so
|
||||||
|
# that autodoc can discover references to it.
|
||||||
|
import _pytest.legacypath # noqa: F401
|
||||||
|
|
@ -0,0 +1,17 @@
|
||||||
|
.. _toc:
|
||||||
|
|
||||||
|
Documentação completa do Pytest
|
||||||
|
===============================
|
||||||
|
|
||||||
|
`Baixe a versão mais recente em PDF <https://media.readthedocs.org/pdf/pytest/latest/pytest.pdf>`_
|
||||||
|
|
||||||
|
.. `Baixe a versão mais recente em EPUB <http://media.readthedocs.org/epub/pytest/latest/pytest.epub>`_
|
||||||
|
|
||||||
|
|
||||||
|
Comece aqui
|
||||||
|
-----------
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
getting-started
|
||||||
|
|
@ -0,0 +1,276 @@
|
||||||
|
.. _get-started:
|
||||||
|
|
||||||
|
Comece aqui
|
||||||
|
===================================
|
||||||
|
|
||||||
|
.. _`getstarted`:
|
||||||
|
.. _`installation`:
|
||||||
|
|
||||||
|
Instale o ``pytest``
|
||||||
|
----------------------------------------
|
||||||
|
|
||||||
|
``pytest`` requer: Python 3.7+ or PyPy3.
|
||||||
|
|
||||||
|
1. Rode o seguinte comando no seu terminal de comandos:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
pip install -U pytest
|
||||||
|
|
||||||
|
2. Confirme que você instalou a versão correta:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
$ pytest --version
|
||||||
|
pytest 7.1.3
|
||||||
|
|
||||||
|
.. _`simpletest`:
|
||||||
|
|
||||||
|
Crie seu primeiro teste
|
||||||
|
----------------------------------------------------------
|
||||||
|
|
||||||
|
Crie um novo arquivo chamado ``test_sample.py``, contendo uma função e um teste:
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
# conteudo de test_sample.py
|
||||||
|
def func(x):
|
||||||
|
return x + 1
|
||||||
|
|
||||||
|
|
||||||
|
def test_answer():
|
||||||
|
assert func(3) == 5
|
||||||
|
|
||||||
|
O teste
|
||||||
|
|
||||||
|
.. code-block:: pytest
|
||||||
|
|
||||||
|
$ pytest
|
||||||
|
=========================== test session starts ============================
|
||||||
|
platform linux -- Python 3.x.y, pytest-7.x.y, pluggy-1.x.y
|
||||||
|
rootdir: /home/sweet/project
|
||||||
|
collected 1 item
|
||||||
|
|
||||||
|
test_sample.py F [100%]
|
||||||
|
|
||||||
|
================================= FAILURES =================================
|
||||||
|
_______________________________ test_answer ________________________________
|
||||||
|
|
||||||
|
def test_answer():
|
||||||
|
> assert func(3) == 5
|
||||||
|
E assert 4 == 5
|
||||||
|
E + where 4 = func(3)
|
||||||
|
|
||||||
|
test_sample.py:6: AssertionError
|
||||||
|
========================= short test summary info ==========================
|
||||||
|
FAILED test_sample.py::test_answer - assert 4 == 5
|
||||||
|
============================ 1 failed in 0.12s =============================
|
||||||
|
|
||||||
|
O ``[100%]`` se refere ao progresso geral de rodar todos os casos de teste. Depois que ele termina, o pytest mostra um
|
||||||
|
relatório de falhas pois ``func(3)`` não retorna ``5``.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
Você pode usar sentenças ``assert`` para verificar resultados esperados. A :ref:`Introspecçao avançada de asserções <python:assert>` do pytest
|
||||||
|
irá inteligentemente reportar valores intermediários da expressão *assert* para que você possa evitar
|
||||||
|
usar os vários nomes de :ref:`métodos legados do JUnit <testcase-objects>`.
|
||||||
|
|
||||||
|
Rode multiplos testes
|
||||||
|
----------------------------------------------------------
|
||||||
|
|
||||||
|
O ``pytest`` vai rodar todos os arquivos que seguirem o padrão test_*.py ou \*_test.py no diretório atual e em seus
|
||||||
|
subdiretórios. De maneira mais geral, ele segue as regras padrões de descoberta de testes.
|
||||||
|
|
||||||
|
..
|
||||||
|
:ref:`regras padrões de descoberta de testes <test discovery>`
|
||||||
|
|
||||||
|
|
||||||
|
Verifique se uma exceção especifica é levantada
|
||||||
|
--------------------------------------------------------------
|
||||||
|
|
||||||
|
Use a expressão auxiliar raises para verificar que algum pedaço de código levanta uma exceção:
|
||||||
|
|
||||||
|
..
|
||||||
|
:ref:`raises <assertraises>`
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
# conteude de test_sysexit.py
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
|
||||||
|
def f():
|
||||||
|
raise SystemExit(1)
|
||||||
|
|
||||||
|
|
||||||
|
def test_mytest():
|
||||||
|
with pytest.raises(SystemExit):
|
||||||
|
f()
|
||||||
|
|
||||||
|
Execute a função de teste com o modo de relatório "quieto" (*quiet*):
|
||||||
|
|
||||||
|
.. code-block:: pytest
|
||||||
|
|
||||||
|
$ pytest -q test_sysexit.py
|
||||||
|
. [100%]
|
||||||
|
1 passed in 0.12s
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
A flag ``-q/--quiet`` é usada para manter a saida desse exemplo e dos próximos pequena.
|
||||||
|
|
||||||
|
Agrupe multiplos testes em uma classe
|
||||||
|
--------------------------------------------------------------
|
||||||
|
|
||||||
|
.. regendoc:wipe
|
||||||
|
|
||||||
|
Depois de desenvolver multiplos testes, você pode querer agrupá-los em uma classe.
|
||||||
|
pytest torna fácil o processo de criar uma classe contendo mais de um teste:
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
# conteudo of test_class.py
|
||||||
|
class TestClass:
|
||||||
|
def test_one(self):
|
||||||
|
x = "this"
|
||||||
|
assert "h" in x
|
||||||
|
|
||||||
|
def test_two(self):
|
||||||
|
x = "hello"
|
||||||
|
assert hasattr(x, "check")
|
||||||
|
|
||||||
|
``pytest`` descobre todos os testes seguindo as Convenções para descoberta de testes Python,
|
||||||
|
então eé encontra ambas as funlções com o prefixo ``test_``. Não há a necessidade de usar subclasses, mas se certifique
|
||||||
|
de usar o prefixo ``Test`` nas suas classes, caso contrário a classe vai ser ignorada. Podemos simplesmente rodar o
|
||||||
|
módulo usando nome do arquivo:
|
||||||
|
|
||||||
|
..
|
||||||
|
:ref:`Convenções para descoberta de testes Python <test discovery>`
|
||||||
|
|
||||||
|
.. code-block:: pytest
|
||||||
|
|
||||||
|
$ pytest -q test_class.py
|
||||||
|
.F [100%]
|
||||||
|
================================= FAILURES =================================
|
||||||
|
____________________________ TestClass.test_two ____________________________
|
||||||
|
|
||||||
|
self = <test_class.TestClass object at 0xdeadbeef0001>
|
||||||
|
|
||||||
|
def test_two(self):
|
||||||
|
x = "hello"
|
||||||
|
> assert hasattr(x, "check")
|
||||||
|
E AssertionError: assert False
|
||||||
|
E + where False = hasattr('hello', 'check')
|
||||||
|
|
||||||
|
test_class.py:8: AssertionError
|
||||||
|
========================= short test summary info ==========================
|
||||||
|
FAILED test_class.py::TestClass::test_two - AssertionError: assert False
|
||||||
|
1 failed, 1 passed in 0.12s
|
||||||
|
|
||||||
|
O primeiro teste passou e o segundo falhou. Você pode facilmente ver os valores intermediários na asserção para ajudar
|
||||||
|
você a entender a razão da falha.
|
||||||
|
|
||||||
|
Agrupar testes em classes traz benefícios pelas seguintes razões:
|
||||||
|
|
||||||
|
* Organização dos testes
|
||||||
|
* Compartilhar fixtures apenas para testes de uma classe em particular
|
||||||
|
* Aplicar marcadores a nível de classe e tê-los implicitamente aplicados para todos os testes
|
||||||
|
|
||||||
|
Uma coisa a manter em mente quando você está agrupando testes dentro de classes é que cada teste tem uma instância
|
||||||
|
única da classe. Ter cada teste compartilhar uma mesma instância da classe prejudicaria o isolamento do teste e também
|
||||||
|
encorajaria más práticas de teste.
|
||||||
|
Isso está detalhado abaixo:
|
||||||
|
|
||||||
|
.. regendoc:wipe
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
# conteudo de test_class_demo.py
|
||||||
|
class TestClassDemoInstance:
|
||||||
|
value = 0
|
||||||
|
|
||||||
|
def test_one(self):
|
||||||
|
self.value = 1
|
||||||
|
assert self.value == 1
|
||||||
|
|
||||||
|
def test_two(self):
|
||||||
|
assert self.value == 1
|
||||||
|
|
||||||
|
|
||||||
|
.. code-block:: pytest
|
||||||
|
|
||||||
|
$ pytest -k TestClassDemoInstance -q
|
||||||
|
.F [100%]
|
||||||
|
================================= FAILURES =================================
|
||||||
|
______________________ TestClassDemoInstance.test_two ______________________
|
||||||
|
|
||||||
|
self = <test_class_demo.TestClassDemoInstance object at 0xdeadbeef0002>
|
||||||
|
|
||||||
|
def test_two(self):
|
||||||
|
> assert self.value == 1
|
||||||
|
E assert 0 == 1
|
||||||
|
E + where 0 = <test_class_demo.TestClassDemoInstance object at 0xdeadbeef0002>.value
|
||||||
|
|
||||||
|
test_class_demo.py:9: AssertionError
|
||||||
|
========================= short test summary info ==========================
|
||||||
|
FAILED test_class_demo.py::TestClassDemoInstance::test_two - assert 0 == 1
|
||||||
|
1 failed, 1 passed in 0.12s
|
||||||
|
|
||||||
|
Note que os atributes adicionados a nivel de classe são *atributos de classe*, então eles são compartilhados entre os
|
||||||
|
testes.
|
||||||
|
|
||||||
|
Use um diretório temporário para testes funcionáis
|
||||||
|
--------------------------------------------------------------
|
||||||
|
|
||||||
|
O ``pytest`` provê Fixtures e argumentos de função padrões para requisitar recursos arbitrários,
|
||||||
|
como um diretório temporário único:
|
||||||
|
|
||||||
|
..
|
||||||
|
:std:doc:`Fixtures e argumentos de função padrões <builtin>`
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
# conteudo de test_tmp_path.py
|
||||||
|
def test_needsfiles(tmp_path):
|
||||||
|
print(tmp_path)
|
||||||
|
assert 0
|
||||||
|
|
||||||
|
Liste o nome ``tmp_path`` na assinatura da função de teste e o ``pytest`` irá procurar e chamar uma fábrica de fixtures
|
||||||
|
para criar o recurso antes de executar a chamada da função de teste. Antes do teste rodar, ``pytest`` cria um
|
||||||
|
diretório temporário que é único para cada invocação/execução daquele teste.
|
||||||
|
|
||||||
|
.. code-block:: pytest
|
||||||
|
|
||||||
|
$ pytest -q test_tmp_path.py
|
||||||
|
F [100%]
|
||||||
|
================================= FAILURES =================================
|
||||||
|
_____________________________ test_needsfiles ______________________________
|
||||||
|
|
||||||
|
tmp_path = PosixPath('PYTEST_TMPDIR/test_needsfiles0')
|
||||||
|
|
||||||
|
def test_needsfiles(tmp_path):
|
||||||
|
print(tmp_path)
|
||||||
|
> assert 0
|
||||||
|
E assert 0
|
||||||
|
|
||||||
|
test_tmp_path.py:3: AssertionError
|
||||||
|
--------------------------- Captured stdout call ---------------------------
|
||||||
|
PYTEST_TMPDIR/test_needsfiles0
|
||||||
|
========================= short test summary info ==========================
|
||||||
|
FAILED test_tmp_path.py::test_needsfiles - assert 0
|
||||||
|
1 failed in 0.12s
|
||||||
|
|
||||||
|
Mais informações sobre como manipular diretórios temporários está disponível em
|
||||||
|
Arquivos e diretórios temporários <tmp_path handling>.
|
||||||
|
|
||||||
|
Conheça que tipos de fixtures do pytest <fixtures> estão disponíveis por padrão com o comando:
|
||||||
|
|
||||||
|
..
|
||||||
|
:ref:`Arquivos e diretórios temporários <tmp_path handling>`
|
||||||
|
:ref:`fixtures do pytest <fixtures>`
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
pytest --fixtures # shows builtin and custom fixtures
|
||||||
|
|
||||||
|
Note que esse comando omite fixtures que começam com ``_`` a não ser que a opção ``-v`` seja adicionada ao comando.
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 25 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 1.3 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 102 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 23 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 17 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 8.1 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 40 KiB |
|
|
@ -0,0 +1,29 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
|
||||||
|
<svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0" y="0" width="1500" height="1500" viewBox="0, 0, 1500, 1500">
|
||||||
|
<g id="pytest_logo">
|
||||||
|
<g id="graphics">
|
||||||
|
<path d="M521.576,213.75 L952.616,213.75 C964.283,213.75 973.741,223.208 973.741,234.875 L973.741,234.875 C973.741,246.542 964.283,256 952.616,256 L521.576,256 C509.909,256 500.451,246.542 500.451,234.875 L500.451,234.875 C500.451,223.208 509.909,213.75 521.576,213.75 z" fill="#696969" id="horizontal_bar"/>
|
||||||
|
<g id="top_bars">
|
||||||
|
<path d="M525.333,171 L612,171 L612,191 L525.333,191 L525.333,171 z" fill="#009FE3"/>
|
||||||
|
<path d="M638.667,171 L725.333,171 L725.333,191 L638.667,191 L638.667,171 z" fill="#C7D302"/>
|
||||||
|
<path d="M750.5,171 L837.167,171 L837.167,191 L750.5,191 L750.5,171 z" fill="#F07E16"/>
|
||||||
|
<path d="M861.861,171 L948.528,171 L948.528,191 L861.861,191 L861.861,171 z" fill="#DF2815"/>
|
||||||
|
</g>
|
||||||
|
<g id="bottom_bars">
|
||||||
|
<path d="M861.861,278 L948.528,278 L948.528,424.5 L861.861,424.5 L861.861,278 z" fill="#DF2815"/>
|
||||||
|
<path d="M750.5,278 L837.328,278 L837.328,516 L750.5,516 L750.5,278 z" fill="#F07E16"/>
|
||||||
|
<path d="M638.667,278 L725.328,278 L725.328,634.5 L638.667,634.5 L638.667,278 z" fill="#C7D302"/>
|
||||||
|
<path d="M525.333,278 L612,278 L612,712.5 L525.333,712.5 L525.333,278 z" fill="#009FE3"/>
|
||||||
|
</g>
|
||||||
|
</g>
|
||||||
|
<g id="pytest">
|
||||||
|
<path d="M252.959,1173.846 Q240.139,1173.846 229.71,1171.021 Q219.28,1168.196 210.914,1163.525 Q202.549,1158.853 196.139,1152.552 Q189.729,1146.25 184.732,1139.297 L182.124,1139.297 Q182.776,1146.685 183.428,1153.421 Q183.862,1159.07 184.297,1165.046 Q184.732,1171.021 184.732,1174.498 L184.732,1276.404 L145.186,1276.404 L145.186,930.921 L177.344,930.921 L182.993,963.079 L184.732,963.079 Q189.729,955.474 196.03,948.847 Q202.332,942.22 210.697,937.331 Q219.063,932.442 229.492,929.509 Q239.922,926.575 252.959,926.575 Q273.384,926.575 290.115,934.397 Q306.846,942.22 318.688,957.756 Q330.53,973.292 337.048,996.324 Q343.567,1019.356 343.567,1049.776 Q343.567,1080.413 337.048,1103.554 Q330.53,1126.695 318.688,1142.339 Q306.846,1157.984 290.115,1165.915 Q273.384,1173.846 252.959,1173.846 z M245.354,959.385 Q228.84,959.385 217.433,964.383 Q206.025,969.38 198.964,979.593 Q191.902,989.805 188.534,1005.015 Q185.166,1020.225 184.732,1040.867 L184.732,1049.776 Q184.732,1071.722 187.665,1088.779 Q190.598,1105.835 197.66,1117.46 Q204.722,1129.085 216.455,1135.06 Q228.189,1141.036 245.789,1141.036 Q275.122,1141.036 288.92,1117.352 Q302.717,1093.667 302.717,1049.341 Q302.717,1004.146 288.92,981.766 Q275.122,959.385 245.354,959.385 z" fill="#696969"/>
|
||||||
|
<path d="M370.293,930.921 L411.36,930.921 L458.076,1064.117 Q461.118,1072.808 464.269,1082.369 Q467.42,1091.929 470.136,1101.49 Q472.852,1111.05 474.807,1119.959 Q476.763,1128.868 477.632,1136.473 L478.936,1136.473 Q480.022,1131.041 482.412,1121.697 Q484.802,1112.354 487.736,1101.816 Q490.669,1091.277 493.82,1081.065 Q496.97,1070.853 499.36,1063.682 L542.6,930.921 L583.45,930.921 L489.148,1200.572 Q483.064,1218.172 476.002,1232.187 Q468.941,1246.202 459.597,1255.979 Q450.254,1265.757 437.651,1271.081 Q425.049,1276.404 407.666,1276.404 Q396.367,1276.404 388.11,1275.209 Q379.854,1274.014 373.987,1272.71 L373.987,1241.204 Q378.55,1242.291 385.503,1243.051 Q392.456,1243.812 400.061,1243.812 Q410.491,1243.812 418.096,1241.313 Q425.701,1238.814 431.35,1234.034 Q437,1229.253 441.019,1222.3 Q445.039,1215.347 448.298,1206.438 L460.684,1171.673 z" fill="#696969"/>
|
||||||
|
<path d="M695.568,1141.47 Q699.479,1141.47 704.368,1141.036 Q709.257,1140.601 713.82,1139.949 Q718.383,1139.297 722.186,1138.428 Q725.988,1137.559 727.944,1136.907 L727.944,1166.893 Q725.119,1168.196 720.773,1169.5 Q716.428,1170.804 711.213,1171.781 Q705.998,1172.759 700.349,1173.302 Q694.699,1173.846 689.267,1173.846 Q675.795,1173.846 664.279,1170.369 Q652.763,1166.893 644.398,1158.418 Q636.032,1149.944 631.252,1135.495 Q626.472,1121.045 626.472,1099.1 L626.472,960.689 L592.792,960.689 L592.792,943.089 L626.472,926.141 L643.42,876.165 L666.235,876.165 L666.235,930.921 L726.206,930.921 L726.206,960.689 L666.235,960.689 L666.235,1099.1 Q666.235,1120.176 673.079,1130.823 Q679.924,1141.47 695.568,1141.47 z" fill="#009FE3"/>
|
||||||
|
<path d="M868.527,1173.846 Q844.626,1173.846 824.853,1165.806 Q805.08,1157.767 790.848,1142.339 Q776.616,1126.912 768.793,1104.097 Q760.971,1081.282 760.971,1051.949 Q760.971,1022.398 768.142,999.148 Q775.312,975.899 788.349,959.711 Q801.386,943.523 819.529,935.049 Q837.673,926.575 859.619,926.575 Q881.13,926.575 898.295,934.289 Q915.461,942.002 927.412,956.017 Q939.362,970.032 945.772,989.697 Q952.182,1009.361 952.182,1033.262 L952.182,1057.815 L801.821,1057.815 Q802.907,1099.751 819.529,1119.524 Q836.152,1139.297 868.962,1139.297 Q880.043,1139.297 889.495,1138.211 Q898.947,1137.125 907.747,1135.06 Q916.547,1132.996 924.804,1129.845 Q933.061,1126.695 941.535,1122.784 L941.535,1157.984 Q932.844,1162.112 924.478,1165.154 Q916.113,1168.196 907.313,1170.152 Q898.513,1172.107 889.061,1172.977 Q879.609,1173.846 868.527,1173.846 z M858.749,959.385 Q833.979,959.385 819.529,976.333 Q805.08,993.282 802.69,1025.657 L909.594,1025.657 Q909.594,1010.882 906.661,998.605 Q903.727,986.329 897.535,977.637 Q891.342,968.946 881.782,964.166 Q872.221,959.385 858.749,959.385 z" fill="#009FE3"/>
|
||||||
|
<path d="M1155.126,1104.097 Q1155.126,1121.48 1148.825,1134.517 Q1142.524,1147.554 1130.682,1156.354 Q1118.84,1165.154 1102.109,1169.5 Q1085.378,1173.846 1064.518,1173.846 Q1040.834,1173.846 1023.886,1170.043 Q1006.938,1166.241 994.118,1158.853 L994.118,1122.784 Q1000.854,1126.26 1009.111,1129.628 Q1017.368,1132.996 1026.494,1135.604 Q1035.62,1138.211 1045.289,1139.841 Q1054.958,1141.47 1064.518,1141.47 Q1078.642,1141.47 1088.528,1139.08 Q1098.415,1136.69 1104.608,1132.236 Q1110.8,1127.781 1113.625,1121.371 Q1116.45,1114.961 1116.45,1107.139 Q1116.45,1100.403 1114.277,1094.971 Q1112.104,1089.539 1106.346,1084.216 Q1100.588,1078.892 1090.593,1073.46 Q1080.598,1068.028 1064.953,1061.292 Q1049.308,1054.556 1036.815,1048.038 Q1024.321,1041.519 1015.629,1033.479 Q1006.938,1025.44 1002.266,1014.902 Q997.595,1004.363 997.595,989.805 Q997.595,974.595 1003.57,962.753 Q1009.545,950.911 1020.41,942.872 Q1031.274,934.832 1046.484,930.704 Q1061.694,926.575 1080.38,926.575 Q1101.457,926.575 1118.948,931.138 Q1136.44,935.701 1152.084,943.089 L1138.395,975.03 Q1124.272,968.729 1109.388,964.057 Q1094.504,959.385 1079.077,959.385 Q1056.913,959.385 1046.266,966.664 Q1035.62,973.943 1035.62,987.415 Q1035.62,995.02 1038.118,1000.669 Q1040.617,1006.319 1046.701,1011.316 Q1052.785,1016.314 1062.997,1021.42 Q1073.21,1026.526 1088.42,1032.828 Q1104.064,1039.346 1116.341,1045.865 Q1128.618,1052.383 1137.309,1060.531 Q1146,1068.68 1150.563,1079.109 Q1155.126,1089.539 1155.126,1104.097 z" fill="#009FE3"/>
|
||||||
|
<path d="M1285.28,1141.47 Q1289.191,1141.47 1294.08,1141.036 Q1298.969,1140.601 1303.532,1139.949 Q1308.095,1139.297 1311.898,1138.428 Q1315.7,1137.559 1317.656,1136.907 L1317.656,1166.893 Q1314.831,1168.196 1310.485,1169.5 Q1306.14,1170.804 1300.925,1171.781 Q1295.71,1172.759 1290.06,1173.302 Q1284.411,1173.846 1278.979,1173.846 Q1265.507,1173.846 1253.991,1170.369 Q1242.475,1166.893 1234.109,1158.418 Q1225.744,1149.944 1220.964,1135.495 Q1216.183,1121.045 1216.183,1099.1 L1216.183,960.689 L1182.504,960.689 L1182.504,943.089 L1216.183,926.141 L1233.132,876.165 L1255.947,876.165 L1255.947,930.921 L1315.917,930.921 L1315.917,960.689 L1255.947,960.689 L1255.947,1099.1 Q1255.947,1120.176 1262.791,1130.823 Q1269.636,1141.47 1285.28,1141.47 z" fill="#009FE3"/>
|
||||||
|
</g>
|
||||||
|
</g>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 7.6 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 31 KiB |
|
|
@ -0,0 +1,128 @@
|
||||||
|
:orphan:
|
||||||
|
|
||||||
|
.. _features:
|
||||||
|
|
||||||
|
pytest: ajuda você a escrever programas melhores
|
||||||
|
================================================
|
||||||
|
|
||||||
|
.. module:: pytest
|
||||||
|
|
||||||
|
O *framework* ``pytest`` torna fácil a tarefa de escrever pequenos, legíveis testes, e consegue escalar para suportar
|
||||||
|
testes funcionais complexos para aplicações e bibliotecas.
|
||||||
|
|
||||||
|
|
||||||
|
``pytest`` requer: Python 3.7+ ou PyPy3.
|
||||||
|
|
||||||
|
**Nome do pacote PyPI**: :pypi:`pytest`
|
||||||
|
|
||||||
|
|
||||||
|
Um exemplo rápido
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
# conteudo de test_sample.py
|
||||||
|
def inc(x):
|
||||||
|
return x + 1
|
||||||
|
|
||||||
|
|
||||||
|
def test_answer():
|
||||||
|
assert inc(3) == 5
|
||||||
|
|
||||||
|
|
||||||
|
Para executá-lo:
|
||||||
|
|
||||||
|
.. code-block:: pytest
|
||||||
|
|
||||||
|
$ pytest
|
||||||
|
=========================== test session starts ============================
|
||||||
|
platform linux -- Python 3.x.y, pytest-7.x.y, pluggy-1.x.y
|
||||||
|
rootdir: /home/sweet/project
|
||||||
|
collected 1 item
|
||||||
|
|
||||||
|
test_sample.py F [100%]
|
||||||
|
|
||||||
|
================================= FAILURES =================================
|
||||||
|
_______________________________ test_answer ________________________________
|
||||||
|
|
||||||
|
def test_answer():
|
||||||
|
> assert inc(3) == 5
|
||||||
|
E assert 4 == 5
|
||||||
|
E + where 4 = inc(3)
|
||||||
|
|
||||||
|
test_sample.py:6: AssertionError
|
||||||
|
========================= short test summary info ==========================
|
||||||
|
FAILED test_sample.py::test_answer - assert 4 == 5
|
||||||
|
============================ 1 failed in 0.12s =============================
|
||||||
|
|
||||||
|
Graças a introspecção detalhada de asserções do ``pytest``, somente puras sentenças de ``assert`` são usadas.
|
||||||
|
Veja :ref:`Começe aqui <getstarted>` para uma indrotução básica de como usar o pytest.
|
||||||
|
|
||||||
|
|
||||||
|
Funcionalidades
|
||||||
|
---------------
|
||||||
|
|
||||||
|
- Informação detalhada sobre sentenças de asserção (não precisa decorar nomes do ``self.assert*``
|
||||||
|
|
||||||
|
- Descoberta automática de módulos de testes e funções
|
||||||
|
|
||||||
|
- Fixtures modulares para gerenciar recursos de testes pequenos ou parametrizados.
|
||||||
|
|
||||||
|
- Capaz de rodar suites de testes escritas usando unittest (incluindo *trial*) e
|
||||||
|
nose sem nenhuma mudança extra.
|
||||||
|
|
||||||
|
- Python 3.7+ ou PyPy 3
|
||||||
|
|
||||||
|
- Arquitetura rica para plugins, com mais de 800+ plugins externos e uma comunidade ativa
|
||||||
|
|
||||||
|
|
||||||
|
Documentação
|
||||||
|
------------
|
||||||
|
|
||||||
|
* :ref:`Comece aqui <get-started>` - instale o pytest e conheça o básico em apenas vinte minutos
|
||||||
|
* Guias how-to - guias com passo a passo, cobrundo um grande conjunto de casos de uso e necessidades
|
||||||
|
* Guias de referência - inclui a referência completa para a API do pytest,
|
||||||
|
uma lista de plugins e mais
|
||||||
|
* Explicações - background, discução de tópicos chaves, resposta a perguntas de alto-nível
|
||||||
|
|
||||||
|
|
||||||
|
Bugs/Pedidos
|
||||||
|
------------
|
||||||
|
|
||||||
|
Por favor use o `gerenciador de bugs do Github <https://github.com/pytest-dev/pytest/issues>`_ para submeter bugs ou
|
||||||
|
pedidos de novas funcionalidades.
|
||||||
|
|
||||||
|
|
||||||
|
Suporte o pytest
|
||||||
|
----------------
|
||||||
|
|
||||||
|
`Open Collective`_ é uma plataforma de financiamento online para comunidades abertas e transparentes.
|
||||||
|
Ela provê ferramentas para arrecadar dinheiro e compartilhar gastos com trasnparencia total.
|
||||||
|
|
||||||
|
Ela é a plataforma recomendada para indivíduos e companhias que queira fazer doações mensais ou imediatas diretamente
|
||||||
|
para o projeto.
|
||||||
|
|
||||||
|
Veja mais detalhes no `pytest collective`_.
|
||||||
|
|
||||||
|
.. _Open Collective: https://opencollective.com
|
||||||
|
.. _pytest collective: https://opencollective.com/pytest
|
||||||
|
|
||||||
|
|
||||||
|
pytest para empresas
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
Disponível como parte da assinatuda Tidelift.
|
||||||
|
|
||||||
|
Os mantedores do pytest e milhares de outros pacotes estão trabalhando com a Tidelift para entregar suporte de nível
|
||||||
|
comercioal e manutenção para as dependencias de código aberto que você usa para construir suas aplicações.
|
||||||
|
Economize tempo, reduça risco, e melhore a saúde do código, enquanto paga exatamente os mantedores das dependencias que
|
||||||
|
você usa.
|
||||||
|
|
||||||
|
`Saiba mais. <https://tidelift.com/subscription/pkg/pypi-pytest?utm_source=pypi-pytest&utm_medium=referral&utm_campaign=enterprise&utm_term=repo>`_
|
||||||
|
|
||||||
|
Segurança
|
||||||
|
~~~~~~~~~
|
||||||
|
|
||||||
|
pytest, até agora, nunca foi associada a uma vulnerabilidade de segurança, mas de qualquer maneira, para reportar
|
||||||
|
uma vulnerabilidade de segurança, por favor use o `Contato de segurança da Tidelift <https://tidelift.com/security>`_.
|
||||||
|
A Tidelift irá coordenar o conserto da vulnerabilidade e sua divulgação.
|
||||||
4
tox.ini
4
tox.ini
|
|
@ -79,7 +79,9 @@ commands =
|
||||||
# the '-t changelog_towncrier_draft' tags makes sphinx include the draft
|
# the '-t changelog_towncrier_draft' tags makes sphinx include the draft
|
||||||
# changelog in the docs; this does not happen on ReadTheDocs because it uses
|
# changelog in the docs; this does not happen on ReadTheDocs because it uses
|
||||||
# the standard sphinx command so the 'changelog_towncrier_draft' is never set there
|
# the standard sphinx command so the 'changelog_towncrier_draft' is never set there
|
||||||
sphinx-build -W --keep-going -b html doc/en doc/en/_build/html -t changelog_towncrier_draft {posargs:}
|
# sphinx-build -W --keep-going -b html doc/en doc/en/_build/html -t changelog_towncrier_draft {posargs:}
|
||||||
|
sphinx-build -W --keep-going -b html doc/pt-br doc/pt-br/_build/html -t changelog_towncrier_draft {posargs:}
|
||||||
|
|
||||||
|
|
||||||
[testenv:docs-checklinks]
|
[testenv:docs-checklinks]
|
||||||
basepython = python3
|
basepython = python3
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue