Skip to content

Removes deprecated cgi function and replaces with email.message.Message #134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
amwell-engineering wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Removes deprecated cgi function and replaces with email.message.Message #134

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5df09e7
Removes deprecated cgi function and replaces with email.message.Message
Jan 10, 2025
ca23196
Adds urls file
Jan 15, 2025
a1c5cff
Update parseheader function
Jan 28, 2025
a9ba09f
Updates docs
Feb 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 28 additions & 36 deletions docs/urls.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ <h1 class="title">Module <code>pywebcopy.urls</code></h1>

import os
import re
from cgi import parse_header
from collections import namedtuple
from email.message import Message
from hashlib import md5
from zlib import adler32

Expand All @@ -53,7 +53,7 @@ <h1 class="title">Module <code>pywebcopy.urls</code></h1>

__all__ = [
&#39;url2path&#39;, &#39;filename_present&#39;, &#39;relate&#39;, &#39;get_etag&#39;, &#39;HIERARCHY&#39;, &#39;LINEAR&#39;,
&#39;parse_url&#39;, &#39;parse_header&#39;, &#39;get_host&#39;, &#39;get_prefix&#39;, &#39;get_suffix&#39;,
&#39;parse_url&#39;, &#39;Message&#39;, &#39;get_host&#39;, &#39;get_prefix&#39;, &#39;get_suffix&#39;,
&#39;Url&#39;, &#39;LocationParseError&#39;, &#39;secure_filename&#39;, &#39;split_first&#39;,
&#39;common_prefix_map&#39;, &#39;common_suffix_map&#39;, &#39;get_content_type_from_headers&#39;,
&#39;Context&#39;, &#39;ContextError&#39;,
Expand Down Expand Up @@ -296,11 +296,18 @@ <h1 class="title">Module <code>pywebcopy.urls</code></h1>
return md5(string).hexdigest()


def parse_separated_header(value: str):
msg = EmailMessage()
msg['content-type'] = 'application/json; charset="utf8"'
main, params = msg.get_content_type(), msg['content-type'].params
return main, params


def get_content_type_from_headers(headers, default=None):
content_type = headers.get(&#39;Content-Type&#39;, default)
if not content_type:
return default
content_type, params = parse_header(content_type)
content_type = parse_separated_header(content_type)
return content_type


Expand Down Expand Up @@ -769,6 +776,22 @@ <h2 class="section-title" id="header-functions">Functions</h2>
return bool(_filter_and_group_segments(url, remove_query=True, remove_frag=True)[1])</code></pre>
</details>
</dd>
<dt id="pywebcopy.urls.parse_separated_header"><code class="name flex">
<span>def <span class="ident">parse_separated_header</span></span>(<span>value: str)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def parse_separated_header(value: str):
msg = EmailMessage()
msg[&#39;content-type&#39;] = &#39;application/json; charset=&#39;utf8&#39;&#39;
main, params = msg.get_content_type(), msg[&#39;content-type&#39;].params
return main, params</code></pre>
</details>
</dd>
<dt id="pywebcopy.urls.get_content_type_from_headers"><code class="name flex">
<span>def <span class="ident">get_content_type_from_headers</span></span>(<span>headers, default=None)</span>
</code></dt>
Expand All @@ -782,7 +805,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
content_type = headers.get(&#39;Content-Type&#39;, default)
if not content_type:
return default
content_type, params = parse_header(content_type)
content_type = parse_separated_header(content_type)
return content_type</code></pre>
</details>
</dd>
Expand Down Expand Up @@ -844,37 +867,6 @@ <h2 class="section-title" id="header-functions">Functions</h2>
return common_suffix_map.get(content_type)</code></pre>
</details>
</dd>
<dt id="pywebcopy.urls.parse_header"><code class="name flex">
<span>def <span class="ident">parse_header</span></span>(<span>line)</span>
</code></dt>
<dd>
<div class="desc"><p>Parse a Content-type like header.</p>
<p>Return the main content-type and a dictionary of options.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def parse_header(line):
&#34;&#34;&#34;Parse a Content-type like header.

Return the main content-type and a dictionary of options.

&#34;&#34;&#34;
parts = _parseparam(&#39;;&#39; + line)
key = parts.__next__()
pdict = {}
for p in parts:
i = p.find(&#39;=&#39;)
if i &gt;= 0:
name = p[:i].strip().lower()
value = p[i+1:].strip()
if len(value) &gt;= 2 and value[0] == value[-1] == &#39;&#34;&#39;:
value = value[1:-1]
value = value.replace(&#39;\\\\&#39;, &#39;\\&#39;).replace(&#39;\\&#34;&#39;, &#39;&#34;&#39;)
pdict[name] = value
return key, pdict</code></pre>
</details>
</dd>
<dt id="pywebcopy.urls.parse_url"><code class="name flex">
<span>def <span class="ident">parse_url</span></span>(<span>url)</span>
</code></dt>
Expand Down Expand Up @@ -1649,7 +1641,7 @@ <h1>Index</h1>
<li><code><a title="pywebcopy.urls.get_host" href="#pywebcopy.urls.get_host">get_host</a></code></li>
<li><code><a title="pywebcopy.urls.get_prefix" href="#pywebcopy.urls.get_prefix">get_prefix</a></code></li>
<li><code><a title="pywebcopy.urls.get_suffix" href="#pywebcopy.urls.get_suffix">get_suffix</a></code></li>
<li><code><a title="pywebcopy.urls.parse_header" href="#pywebcopy.urls.parse_header">parse_header</a></code></li>
<li><code><a title="pywebcopy.urls.parse_separated_header" href="#pywebcopy.urls.parse_separated_header">parse_separated_header</a></code></li>
<li><code><a title="pywebcopy.urls.parse_url" href="#pywebcopy.urls.parse_url">parse_url</a></code></li>
<li><code><a title="pywebcopy.urls.relate" href="#pywebcopy.urls.relate">relate</a></code></li>
<li><code><a title="pywebcopy.urls.secure_filename" href="#pywebcopy.urls.secure_filename">secure_filename</a></code></li>
Expand Down
13 changes: 10 additions & 3 deletions pywebcopy/urls.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@

import os
import re
from cgi import parse_header
from collections import namedtuple
from email.message import EmailMessage
from hashlib import md5
from zlib import adler32

Expand All @@ -25,7 +25,7 @@

__all__ = [
'url2path', 'filename_present', 'relate', 'get_etag', 'HIERARCHY', 'LINEAR',
'parse_url', 'parse_header', 'get_host', 'get_prefix', 'get_suffix',
'parse_url', 'Message', 'get_host', 'get_prefix', 'get_suffix',
'Url', 'LocationParseError', 'secure_filename', 'split_first',
'common_prefix_map', 'common_suffix_map', 'get_content_type_from_headers',
'Context', 'ContextError',
Expand Down Expand Up @@ -272,11 +272,18 @@ def get_etag(string):
return md5(string).hexdigest()


def parse_separated_header(value: str):
msg = EmailMessage()
msg['content-type'] = 'application/json; charset="utf8"'
main, params = msg.get_content_type(), msg['content-type'].params
return main, params


def get_content_type_from_headers(headers, default=None):
content_type = headers.get('Content-Type', default)
if not content_type:
return default
content_type, params = parse_header(content_type)
content_type = parse_separated_header(content_type)
return content_type


Expand Down