ED/EDMarketConnector
1
0
Fork 0
mirror of https://github.com/EDCD/EDMarketConnector.git synced 2025-04-13 15:57:14 +03:00
Code Issues Projects Releases Wiki Activity

PLUGINS: Document that they should use requests, not urllib, and why

Browse Source
This commit is contained in:
Athanasius 2023-01-18 11:44:51 +00:00
parent 650b43cc3c
commit 8b9379a89e
No known key found for this signature in database
GPG Key ID: 772697E181BB2767
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
PLUGINS.md
View File

@ -381,6 +381,20 @@ So instead use:
# During shutdown
```
### Use `requests`, not `urllib` for HTTP(S) requests
We use `requests` in lots of core code, so it will always be available. An
advantage to using it, instead of the core `urllib`, is that it brings in
`certifi` with its own set of trusted root certificates.
We've seen issues where a plugin was using `urllib`, which uses the **system**
certificate store, and a user's system didn't yet have a new root certificate
that was necessary for the operation of a URL the plugin was acessing.
We keep `requests`, and thus `certifi` up to date via GitHub's dependabot. If
there is ever a certificate update that we don't have in a release then
please open a
[bug report](https://github.com/EDCD/EDMarketConnector/issues/new?assignees=&labels=bug%2C+unconfirmed&template=bug_report.md&title=).
---
## Plugin Hooks