Skip to content

Commit 1740e42

Browse files
authored
Merge pull request #32 from Carreau/38-misc
Misc Updates and bump to 3.8+
2 parents 65f17ab + 934314d commit 1740e42

File tree

11 files changed

+328
-253
lines changed

11 files changed

+328
-253
lines changed

.github/workflows/test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ jobs:
77
runs-on: ubuntu-latest
88
strategy:
99
matrix:
10-
python-version: [ '3.8', '3.9', '3.10', '3.11', '3.12', '3.13']
10+
python-version: [ '3.8', '3.9', '3.10', '3.11', '3.12', '3.13', '3.14', '3.14t']
1111
steps:
1212
- uses: actions/checkout@v5
1313

doc/conf.py

Lines changed: 78 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -19,223 +19,225 @@
1919
# If extensions (or modules to document with autodoc) are in another directory,
2020
# add these directories to sys.path here. If the directory is relative to the
2121
# documentation root, use os.path.abspath to make it absolute, like shown here.
22-
sys.path.insert(0, os.path.abspath('..'))
22+
sys.path.insert(0, os.path.abspath(".."))
2323

2424
# -- General configuration ------------------------------------------------
2525

2626
# If your documentation needs a minimal Sphinx version, state it here.
27-
#needs_sphinx = '1.0'
27+
# needs_sphinx = '1.0'
2828

2929
# Add any Sphinx extension module names here, as strings. They can be
3030
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
3131
# ones.
3232
extensions = [
33-
'sphinx.ext.autodoc',
34-
'sphinx.ext.intersphinx',
33+
"sphinx.ext.autodoc",
34+
"sphinx.ext.intersphinx",
3535
]
3636

3737
# Add any paths that contain templates here, relative to this directory.
38-
templates_path = ['_templates']
38+
templates_path = ["_templates"]
3939

4040
# The suffix of source filenames.
4141
source_suffix = {".rst": "restructuredtext"}
4242

4343
# The encoding of source files.
44-
#source_encoding = 'utf-8-sig'
44+
# source_encoding = 'utf-8-sig'
4545

4646
# The master toctree document.
47-
master_doc = 'index'
47+
master_doc = "index"
4848

4949
# General information about the project.
50-
project = 'Testpath'
51-
copyright = '2015, Jupyter Development Team'
50+
project = "Testpath"
51+
copyright = "2015, Jupyter Development Team"
5252

5353
# The version info for the project you're documenting, acts as replacement for
5454
# |version| and |release|, also used in various other places throughout the
5555
# built documents.
5656
#
5757
# The short X.Y version.
58-
version = '0.4.4'
58+
version = "0.4.4"
5959
# The full version, including alpha/beta/rc tags.
6060
release = version
6161

6262
# The language for content autogenerated by Sphinx. Refer to documentation
6363
# for a list of supported languages.
64-
#language = None
64+
# language = None
6565

6666
# There are two options for replacing |today|: either, you set today to some
6767
# non-false value, then it is used:
68-
#today = ''
68+
# today = ''
6969
# Else, today_fmt is used as the format for a strftime call.
70-
#today_fmt = '%B %d, %Y'
70+
# today_fmt = '%B %d, %Y'
7171

7272
# List of patterns, relative to source directory, that match files and
7373
# directories to ignore when looking for source files.
74-
exclude_patterns = ['_build']
74+
exclude_patterns = ["_build"]
7575

7676
# The reST default role (used for this markup: `text`) to use for all
7777
# documents.
78-
#default_role = None
78+
# default_role = None
7979

8080
# If true, '()' will be appended to :func: etc. cross-reference text.
81-
#add_function_parentheses = True
81+
# add_function_parentheses = True
8282

8383
# If true, the current module name will be prepended to all description
8484
# unit titles (such as .. function::).
85-
#add_module_names = True
85+
# add_module_names = True
8686

8787
# If true, sectionauthor and moduleauthor directives will be shown in the
8888
# output. They are ignored by default.
89-
#show_authors = False
89+
# show_authors = False
9090

9191
# The name of the Pygments (syntax highlighting) style to use.
92-
pygments_style = 'sphinx'
92+
pygments_style = "sphinx"
9393

9494
# A list of ignored prefixes for module index sorting.
95-
#modindex_common_prefix = []
95+
# modindex_common_prefix = []
9696

9797
# If true, keep warnings as "system message" paragraphs in the built documents.
98-
#keep_warnings = False
98+
# keep_warnings = False
9999

100100

101101
# -- Options for HTML output ----------------------------------------------
102102

103103
# The theme to use for HTML and HTML Help pages. See the documentation for
104104
# a list of builtin themes.
105-
html_theme = 'default'
105+
html_theme = "default"
106106

107107
# Theme options are theme-specific and customize the look and feel of a theme
108108
# further. For a list of options available for each theme, see the
109109
# documentation.
110-
#html_theme_options = {}
110+
# html_theme_options = {}
111111

112112
# Add any paths that contain custom themes here, relative to this directory.
113-
#html_theme_path = []
113+
# html_theme_path = []
114114

115115
# The name for this set of Sphinx documents. If None, it defaults to
116116
# "<project> v<release> documentation".
117-
#html_title = None
117+
# html_title = None
118118

119119
# A shorter title for the navigation bar. Default is the same as html_title.
120-
#html_short_title = None
120+
# html_short_title = None
121121

122122
# The name of an image file (relative to this directory) to place at the top
123123
# of the sidebar.
124-
#html_logo = None
124+
# html_logo = None
125125

126126
# The name of an image file (within the static path) to use as favicon of the
127127
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
128128
# pixels large.
129-
#html_favicon = None
129+
# html_favicon = None
130130

131131
# Add any paths that contain custom static files (such as style sheets) here,
132132
# relative to this directory. They are copied after the builtin static files,
133133
# so a file named "default.css" will overwrite the builtin "default.css".
134-
html_static_path = ['_static']
134+
html_static_path = ["_static"]
135135

136136
# Add any extra paths that contain custom files (such as robots.txt or
137137
# .htaccess) here, relative to this directory. These files are copied
138138
# directly to the root of the documentation.
139-
#html_extra_path = []
139+
# html_extra_path = []
140140

141141
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
142142
# using the given strftime format.
143-
#html_last_updated_fmt = '%b %d, %Y'
143+
# html_last_updated_fmt = '%b %d, %Y'
144144

145145
# If true, SmartyPants will be used to convert quotes and dashes to
146146
# typographically correct entities.
147-
#html_use_smartypants = True
147+
# html_use_smartypants = True
148148

149149
# Custom sidebar templates, maps document names to template names.
150-
#html_sidebars = {}
150+
# html_sidebars = {}
151151

152152
# Additional templates that should be rendered to pages, maps page names to
153153
# template names.
154-
#html_additional_pages = {}
154+
# html_additional_pages = {}
155155

156156
# If false, no module index is generated.
157-
#html_domain_indices = True
157+
# html_domain_indices = True
158158

159159
# If false, no index is generated.
160-
#html_use_index = True
160+
# html_use_index = True
161161

162162
# If true, the index is split into individual pages for each letter.
163-
#html_split_index = False
163+
# html_split_index = False
164164

165165
# If true, links to the reST sources are added to the pages.
166-
#html_show_sourcelink = True
166+
# html_show_sourcelink = True
167167

168168
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
169-
#html_show_sphinx = True
169+
# html_show_sphinx = True
170170

171171
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
172-
#html_show_copyright = True
172+
# html_show_copyright = True
173173

174174
# If true, an OpenSearch description file will be output, and all pages will
175175
# contain a <link> tag referring to it. The value of this option must be the
176176
# base URL from which the finished HTML is served.
177-
#html_use_opensearch = ''
177+
# html_use_opensearch = ''
178178

179179
# This is the file name suffix for HTML files (e.g. ".xhtml").
180-
#html_file_suffix = None
180+
# html_file_suffix = None
181181

182182
# Output file base name for HTML help builder.
183-
htmlhelp_basename = 'Testpathdoc'
183+
htmlhelp_basename = "Testpathdoc"
184184

185185

186186
# -- Options for LaTeX output ---------------------------------------------
187187

188188
latex_elements = {
189-
# The paper size ('letterpaper' or 'a4paper').
190-
#'papersize': 'letterpaper',
191-
192-
# The font size ('10pt', '11pt' or '12pt').
193-
#'pointsize': '10pt',
194-
195-
# Additional stuff for the LaTeX preamble.
196-
#'preamble': '',
189+
# The paper size ('letterpaper' or 'a4paper').
190+
#'papersize': 'letterpaper',
191+
# The font size ('10pt', '11pt' or '12pt').
192+
#'pointsize': '10pt',
193+
# Additional stuff for the LaTeX preamble.
194+
#'preamble': '',
197195
}
198196

199197
# Grouping the document tree into LaTeX files. List of tuples
200198
# (source start file, target name, title,
201199
# author, documentclass [howto, manual, or own class]).
202200
latex_documents = [
203-
('index', 'Testpath.tex', 'Testpath Documentation',
204-
'Jupyter Development Team', 'manual'),
201+
(
202+
"index",
203+
"Testpath.tex",
204+
"Testpath Documentation",
205+
"Jupyter Development Team",
206+
"manual",
207+
),
205208
]
206209

207210
# The name of an image file (relative to this directory) to place at the top of
208211
# the title page.
209-
#latex_logo = None
212+
# latex_logo = None
210213

211214
# For "manual" documents, if this is true, then toplevel headings are parts,
212215
# not chapters.
213-
#latex_use_parts = False
216+
# latex_use_parts = False
214217

215218
# If true, show page references after internal links.
216-
#latex_show_pagerefs = False
219+
# latex_show_pagerefs = False
217220

218221
# If true, show URL addresses after external links.
219-
#latex_show_urls = False
222+
# latex_show_urls = False
220223

221224
# Documents to append as an appendix to all manuals.
222-
#latex_appendices = []
225+
# latex_appendices = []
223226

224227
# If false, no module index is generated.
225-
#latex_domain_indices = True
228+
# latex_domain_indices = True
226229

227230

228231
# -- Options for manual page output ---------------------------------------
229232

230233
# One entry per manual page. List of tuples
231234
# (source start file, name, description, authors, manual section).
232235
man_pages = [
233-
('index', 'testpath', 'Testpath Documentation',
234-
['Jupyter Development Team'], 1)
236+
("index", "testpath", "Testpath Documentation", ["Jupyter Development Team"], 1)
235237
]
236238

237239
# If true, show URL addresses after external links.
238-
#man_show_urls = False
240+
# man_show_urls = False
239241

240242

241243
# -- Options for Texinfo output -------------------------------------------
@@ -244,23 +246,29 @@
244246
# (source start file, target name, title, author,
245247
# dir menu entry, description, category)
246248
texinfo_documents = [
247-
('index', 'Testpath', 'Testpath Documentation',
248-
'Jupyter Development Team', 'Testpath', 'One line description of project.',
249-
'Miscellaneous'),
249+
(
250+
"index",
251+
"Testpath",
252+
"Testpath Documentation",
253+
"Jupyter Development Team",
254+
"Testpath",
255+
"One line description of project.",
256+
"Miscellaneous",
257+
),
250258
]
251259

252260
# Documents to append as an appendix to all manuals.
253-
#texinfo_appendices = []
261+
# texinfo_appendices = []
254262

255263
# If false, no module index is generated.
256-
#texinfo_domain_indices = True
264+
# texinfo_domain_indices = True
257265

258266
# How to display URL addresses: 'footnote', 'no', or 'inline'.
259-
#texinfo_show_urls = 'footnote'
267+
# texinfo_show_urls = 'footnote'
260268

261269
# If true, do not generate a @detailmenu in the "Top" node's menu.
262-
#texinfo_no_detailmenu = False
270+
# texinfo_no_detailmenu = False
263271

264272

265273
# configuration for intersphinx: refer to the Python standard library.
266-
intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
274+
intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ authors = [
88
{name="Jupyter Development Team", email="[email protected]"},
99
]
1010
readme = "README.rst"
11-
requires-python = ">= 3.5"
11+
requires-python = ">= 3.8"
1212
classifiers = [
1313
"Intended Audience :: Developers",
1414
"License :: OSI Approved :: BSD License",

testpath/__init__.py

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
11
"""Test utilities for code working with files and commands"""
2-
from .asserts import *
3-
from .env import temporary_env, modified_env, make_env_restorer
4-
from .commands import MockCommand, assert_calls
52

6-
__version__ = '0.6.0'
3+
from .asserts import (
4+
assert_path_exists as assert_path_exists,
5+
assert_not_path_exists as assert_not_path_exists,
6+
assert_isfile as assert_isfile,
7+
assert_not_isfile as assert_not_isfile,
8+
assert_isdir as assert_isdir,
9+
assert_not_isdir as assert_not_isdir,
10+
assert_islink as assert_islink,
11+
assert_not_islink as assert_not_islink,
12+
assert_ispipe as assert_ispipe,
13+
assert_not_ispipe as assert_not_ispipe,
14+
assert_issocket as assert_issocket,
15+
assert_not_issocket as assert_not_issocket,
16+
)
17+
18+
from .env import (
19+
temporary_env as temporary_env,
20+
modified_env as modified_env,
21+
make_env_restorer as make_env_restorer,
22+
)
23+
from .commands import MockCommand as MockCommand, assert_calls as assert_calls
24+
25+
__version__ = "0.6.0"

0 commit comments

Comments
 (0)