Skip to content

Commit 8ffd9fb

Browse files
committed
chore: Template upgrade
1 parent f6387ae commit 8ffd9fb

26 files changed

+210
-208
lines changed

.copier-answers.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# Changes here will be overwritten by Copier
2-
_commit: 1.5.6
1+
# Changes here will be overwritten by Copier.
2+
_commit: 1.8.1
33
_src_path: gh:pawamoy/copier-uv
44
author_email: dev@pawamoy.fr
55
author_fullname: Timothée Mazzucotelli
66
author_username: pawamoy
77
copyright_date: '2021'
88
copyright_holder: Timothée Mazzucotelli
99
copyright_holder_email: dev@pawamoy.fr
10-
copyright_license: ISC License
10+
copyright_license: ISC
1111
insiders: true
1212
insiders_email: insiders@pawamoy.fr
1313
insiders_repository_name: griffe

.github/FUNDING.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,2 @@
11
github: pawamoy
2-
ko_fi: pawamoy
32
polar: pawamoy
4-
custom:
5-
- https://www.paypal.me/pawamoy

.github/workflows/ci.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ jobs:
3838
python-version: "3.12"
3939

4040
- name: Setup uv
41-
uses: astral-sh/setup-uv@v3
41+
uses: astral-sh/setup-uv@v5
4242
with:
4343
enable-cache: true
4444
cache-dependency-glob: pyproject.toml
@@ -127,11 +127,11 @@ jobs:
127127
allow-prereleases: true
128128

129129
- name: Setup uv
130-
uses: astral-sh/setup-uv@v3
130+
uses: astral-sh/setup-uv@v5
131131
with:
132132
enable-cache: true
133133
cache-dependency-glob: pyproject.toml
134-
cache-suffix: py${{ matrix.python-version }}
134+
cache-suffix: ${{ matrix.resolution }}
135135

136136
- name: Install dependencies
137137
env:

.github/workflows/release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ jobs:
1919
with:
2020
python-version: "3.12"
2121
- name: Setup uv
22-
uses: astral-sh/setup-uv@v3
22+
uses: astral-sh/setup-uv@v5
2323
- name: Build dists
2424
if: github.repository_owner == 'pawamoy-insiders'
2525
run: uv tool run --from build pyproject-build

CODE_OF_CONDUCT.md

Lines changed: 25 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -2,128 +2,79 @@
22

33
## Our Pledge
44

5-
We as members, contributors, and leaders pledge to make participation in our
6-
community a harassment-free experience for everyone, regardless of age, body
7-
size, visible or invisible disability, ethnicity, sex characteristics, gender
8-
identity and expression, level of experience, education, socio-economic status,
9-
nationality, personal appearance, race, caste, color, religion, or sexual
10-
identity and orientation.
5+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
116

12-
We pledge to act and interact in ways that contribute to an open, welcoming,
13-
diverse, inclusive, and healthy community.
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
148

159
## Our Standards
1610

17-
Examples of behavior that contributes to a positive environment for our
18-
community include:
11+
Examples of behavior that contributes to a positive environment for our community include:
1912

2013
* Demonstrating empathy and kindness toward other people
2114
* Being respectful of differing opinions, viewpoints, and experiences
2215
* Giving and gracefully accepting constructive feedback
23-
* Accepting responsibility and apologizing to those affected by our mistakes,
24-
and learning from the experience
25-
* Focusing on what is best not just for us as individuals, but for the overall
26-
community
16+
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17+
* Focusing on what is best not just for us as individuals, but for the overall community
2718

2819
Examples of unacceptable behavior include:
2920

30-
* The use of sexualized language or imagery, and sexual attention or advances of
31-
any kind
21+
* The use of sexualized language or imagery, and sexual attention or advances of any kind
3222
* Trolling, insulting or derogatory comments, and personal or political attacks
3323
* Public or private harassment
34-
* Publishing others' private information, such as a physical or email address,
35-
without their explicit permission
36-
* Other conduct which could reasonably be considered inappropriate in a
37-
professional setting
24+
* Publishing others' private information, such as a physical or email address, without their explicit permission
25+
* Other conduct which could reasonably be considered inappropriate in a professional setting
3826

3927
## Enforcement Responsibilities
4028

41-
Community leaders are responsible for clarifying and enforcing our standards of
42-
acceptable behavior and will take appropriate and fair corrective action in
43-
response to any behavior that they deem inappropriate, threatening, offensive,
44-
or harmful.
29+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
4530

46-
Community leaders have the right and responsibility to remove, edit, or reject
47-
comments, commits, code, wiki edits, issues, and other contributions that are
48-
not aligned to this Code of Conduct, and will communicate reasons for moderation
49-
decisions when appropriate.
31+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
5032

5133
## Scope
5234

53-
This Code of Conduct applies within all community spaces, and also applies when
54-
an individual is officially representing the community in public spaces.
55-
Examples of representing our community include using an official e-mail address,
56-
posting via an official social media account, or acting as an appointed
57-
representative at an online or offline event.
35+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
5836

5937
## Enforcement
6038

61-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62-
reported to the community leaders responsible for enforcement at
63-
dev@pawamoy.fr.
64-
All complaints will be reviewed and investigated promptly and fairly.
39+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at dev@pawamoy.fr. All complaints will be reviewed and investigated promptly and fairly.
6540

66-
All community leaders are obligated to respect the privacy and security of the
67-
reporter of any incident.
41+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
6842

6943
## Enforcement Guidelines
7044

71-
Community leaders will follow these Community Impact Guidelines in determining
72-
the consequences for any action they deem in violation of this Code of Conduct:
45+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
7346

7447
### 1. Correction
7548

76-
**Community Impact**: Use of inappropriate language or other behavior deemed
77-
unprofessional or unwelcome in the community.
49+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
7850

79-
**Consequence**: A private, written warning from community leaders, providing
80-
clarity around the nature of the violation and an explanation of why the
81-
behavior was inappropriate. A public apology may be requested.
51+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
8252

8353
### 2. Warning
8454

85-
**Community Impact**: A violation through a single incident or series of
86-
actions.
55+
**Community Impact**: A violation through a single incident or series of actions.
8756

88-
**Consequence**: A warning with consequences for continued behavior. No
89-
interaction with the people involved, including unsolicited interaction with
90-
those enforcing the Code of Conduct, for a specified period of time. This
91-
includes avoiding interactions in community spaces as well as external channels
92-
like social media. Violating these terms may lead to a temporary or permanent
93-
ban.
57+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
9458

9559
### 3. Temporary Ban
9660

97-
**Community Impact**: A serious violation of community standards, including
98-
sustained inappropriate behavior.
61+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
9962

100-
**Consequence**: A temporary ban from any sort of interaction or public
101-
communication with the community for a specified period of time. No public or
102-
private interaction with the people involved, including unsolicited interaction
103-
with those enforcing the Code of Conduct, is allowed during this period.
104-
Violating these terms may lead to a permanent ban.
63+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
10564

10665
### 4. Permanent Ban
10766

108-
**Community Impact**: Demonstrating a pattern of violation of community
109-
standards, including sustained inappropriate behavior, harassment of an
110-
individual, or aggression toward or disparagement of classes of individuals.
67+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
11168

112-
**Consequence**: A permanent ban from any sort of public interaction within the
113-
community.
69+
**Consequence**: A permanent ban from any sort of public interaction within the community.
11470

11571
## Attribution
11672

117-
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118-
version 2.1, available at
119-
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
73+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
12074

121-
Community Impact Guidelines were inspired by
122-
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
75+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
12376

124-
For answers to common questions about this code of conduct, see the FAQ at
125-
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126-
[https://www.contributor-covenant.org/translations][translations].
77+
For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
12778

12879
[homepage]: https://www.contributor-covenant.org
12980
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

config/ruff.toml

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -38,32 +38,38 @@ ignore = [
3838
logger-objects = ["_griffe.logger.logger"]
3939

4040
[lint.per-file-ignores]
41-
"src/*/__main__.py" = [
41+
"src/griffe/__main__.py" = [
4242
"D100", # Missing module docstring
4343
]
44-
"src/*/cli.py" = [
44+
"src/_griffe/cli.py" = [
4545
"T201", # Print statement
4646
]
47-
"src/*/git.py" = [
47+
"src/_griffe/git.py" = [
4848
"S603", # `subprocess` call: check for execution of untrusted input
4949
"S607", # Starting a process with a partial executable path
5050
]
51-
"tests/test_git.py" = [
52-
"S603", # `subprocess` call: check for execution of untrusted input
53-
"S607", # Starting a process with a partial executable path
54-
]
55-
"src/*/*/nodes/*.py" = [
51+
"src/_griffe/agents/nodes/*.py" = [
5652
"ARG001", # Unused function argument
5753
"N812", # Lowercase `keyword` imported as non-lowercase `NodeKeyword`
5854
]
59-
"src/*/debug.py" = [
55+
"src/_griffe/debug.py" = [
6056
"T201", # Print statement
6157
]
58+
"src/_griffe/**.py" = [
59+
"D100", # Missing docstring in public module
60+
]
6261
"scripts/*.py" = [
62+
"D100", # Missing docstring in public module
63+
"D101", # Missing docstring in public class
64+
"D103", # Missing docstring in public function
6365
"INP001", # File is part of an implicit namespace package
6466
"T201", # Print statement
6567
]
66-
"tests/*.py" = [
68+
"tests/test_git.py" = [
69+
"S603", # `subprocess` call: check for execution of untrusted input
70+
"S607", # Starting a process with a partial executable path
71+
]
72+
"tests/**.py" = [
6773
"ARG005", # Unused lambda argument
6874
"FBT001", # Boolean positional arg in function definition
6975
"PLC1901", # a == "" can be simplified to not a

config/vscode/launch.json

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,17 @@
77
"request": "launch",
88
"program": "${file}",
99
"console": "integratedTerminal",
10-
"justMyCode": false
10+
"justMyCode": false,
11+
"args": "${command:pickArgs}"
12+
},
13+
{
14+
"name": "run",
15+
"type": "debugpy",
16+
"request": "launch",
17+
"module": "griffe",
18+
"console": "integratedTerminal",
19+
"justMyCode": false,
20+
"args": "${command:pickArgs}"
1121
},
1222
{
1323
"name": "docs",

docs/.overrides/partials/comments.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ <h2 id="__comments">Feedback</h2>
3131
: "light"
3232

3333
// Instruct Giscus to set theme
34-
giscus.setAttribute("data-theme", theme)
34+
giscus.setAttribute("data-theme", theme)
3535
}
3636

3737
// Register event handlers after documented loaded

docs/changelog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
title: Changelog
23
hide:
34
- navigation
45
---

docs/contributing.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Contributing
3+
---
4+
15
# Contributing
26

37
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

docs/credits.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
title: Credits
23
hide:
34
- toc
45
---

docs/css/mkdocstrings.css

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,48 @@ a.autorefs-external:hover::after {
4141
li.md-nav__item:has(> a[href*="("]) {
4242
display: none;
4343
}
44+
45+
/* Tree-like output for backlinks. */
46+
.doc-backlink-list {
47+
--tree-clr: var(--md-default-fg-color);
48+
--tree-font-size: 1rem;
49+
--tree-item-height: 1;
50+
--tree-offset: 1rem;
51+
--tree-thickness: 1px;
52+
--tree-style: solid;
53+
display: grid;
54+
list-style: none !important;
55+
}
56+
57+
.doc-backlink-list li > span:first-child {
58+
text-indent: .3rem;
59+
}
60+
.doc-backlink-list li {
61+
padding-inline-start: var(--tree-offset);
62+
border-left: var(--tree-thickness) var(--tree-style) var(--tree-clr);
63+
position: relative;
64+
margin-left: 0 !important;
65+
66+
&:last-child {
67+
border-color: transparent;
68+
}
69+
&::before{
70+
content: '';
71+
position: absolute;
72+
top: calc(var(--tree-item-height) / 2 * -1 * var(--tree-font-size) + var(--tree-thickness));
73+
left: calc(var(--tree-thickness) * -1);
74+
width: calc(var(--tree-offset) + var(--tree-thickness) * 2);
75+
height: calc(var(--tree-item-height) * var(--tree-font-size));
76+
border-left: var(--tree-thickness) var(--tree-style) var(--tree-clr);
77+
border-bottom: var(--tree-thickness) var(--tree-style) var(--tree-clr);
78+
}
79+
&::after{
80+
content: '';
81+
position: absolute;
82+
border-radius: 50%;
83+
background-color: var(--tree-clr);
84+
top: calc(var(--tree-item-height) / 2 * 1rem);
85+
left: var(--tree-offset) ;
86+
translate: calc(var(--tree-thickness) * -1) calc(var(--tree-thickness) * -1);
87+
}
88+
}

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
title: Overview
23
hide:
34
- feedback
45
- navigation

0 commit comments

Comments
 (0)