Skip to content

Commit

Permalink
Adding tests for module_locate (#847)
Browse files Browse the repository at this point in the history
## Summary of Changes
-Adds support for dependencies that are compiled into the Python
interpreter like `time` and `sys`
-Adds and improves tests for module_locate module

### Related issues

Resolves #782
Resolves #795 9754f0c
  • Loading branch information
github-actions[bot] committed Mar 15, 2024
1 parent c4f0176 commit 8d7bee0
Show file tree
Hide file tree
Showing 1,517 changed files with 221,999 additions and 221,522 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -365,7 +365,7 @@ <h3>Instance variables</h3>
<h3>Methods</h3>
<dl>
<dt id="skema.img2mml.models.decoders.xfmer_decoder.Transformer_Decoder.create_pad_mask"><code class="name flex">
<span>def <span class="ident">create_pad_mask</span></span>(<span>self, matrix: <built-in method tensor of type object at 0x7b3a0815b500>, pad_token: int) ‑> <built-in method tensor of type object at 0x7b3a0815b500></span>
<span>def <span class="ident">create_pad_mask</span></span>(<span>self, matrix: <built-in method tensor of type object at 0x78fc77b5b500>, pad_token: int) ‑> <built-in method tensor of type object at 0x78fc77b5b500></span>
</code></dt>
<dd>
<div class="desc"></div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ <h3>Class variables</h3>
<h3>Methods</h3>
<dl>
<dt id="skema.img2mml.models.encoding.positional_encoding_for_xfmer.PositionalEncoding.forward"><code class="name flex">
<span>def <span class="ident">forward</span></span>(<span>self, x: <built-in method tensor of type object at 0x7b3a0815b500>) ‑> <built-in method tensor of type object at 0x7b3a0815b500></span>
<span>def <span class="ident">forward</span></span>(<span>self, x: <built-in method tensor of type object at 0x78fc77b5b500>) ‑> <built-in method tensor of type object at 0x78fc77b5b500></span>
</code></dt>
<dd>
<div class="desc"><p>Defines the computation performed at every call.</p>
Expand Down
16 changes: 14 additions & 2 deletions api/python/skema/program_analysis/module_locate.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,9 @@ <h1 class="title">Module <code>skema.program_analysis.module_locate</code></h1>
def identify_source_type(source: str):
if not source:
return &#34;Unknown&#34;
if &#34;github&#34; in source:
elif source == &#34;https://github.com/python/cpython&#34;:
return &#34;Compiled&#34;
elif &#34;github&#34; in source:
return &#34;Repository&#34;
elif source.startswith(&#34;http&#34;):
return &#34;Url&#34;
Expand Down Expand Up @@ -82,6 +84,10 @@ <h1 class="title">Module <code>skema.program_analysis.module_locate</code></h1>
:return: The module&#39;s file path, GitHub URL, or tarball URL.
&#34;&#34;&#34;

# Check if module is compiled into Python
if module_name in sys.builtin_module_names:
return &#34;https://github.com/python/cpython&#34;

# Attempt to find the module in the local environment
try:
module_obj = importlib.import_module(module_name)
Expand Down Expand Up @@ -183,7 +189,9 @@ <h2 class="section-title" id="header-functions">Functions</h2>
<pre><code class="python">def identify_source_type(source: str):
if not source:
return &#34;Unknown&#34;
if &#34;github&#34; in source:
elif source == &#34;https://github.com/python/cpython&#34;:
return &#34;Compiled&#34;
elif &#34;github&#34; in source:
return &#34;Repository&#34;
elif source.startswith(&#34;http&#34;):
return &#34;Url&#34;
Expand Down Expand Up @@ -215,6 +223,10 @@ <h2 class="section-title" id="header-functions">Functions</h2>
:return: The module&#39;s file path, GitHub URL, or tarball URL.
&#34;&#34;&#34;

# Check if module is compiled into Python
if module_name in sys.builtin_module_names:
return &#34;https://github.com/python/cpython&#34;

# Attempt to find the module in the local environment
try:
module_obj = importlib.import_module(module_name)
Expand Down
5 changes: 5 additions & 0 deletions api/python/skema/program_analysis/tests/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,10 @@ <h2 class="section-title" id="header-submodules">Sub-modules</h2>
<dd>
<div class="desc"></div>
</dd>
<dt><code class="name"><a title="skema.program_analysis.tests.test_module_locate" href="test_module_locate.html">skema.program_analysis.tests.test_module_locate</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt><code class="name"><a title="skema.program_analysis.tests.test_operation_cast" href="test_operation_cast.html">skema.program_analysis.tests.test_operation_cast</a></code></dt>
<dd>
<div class="desc"></div>
Expand Down Expand Up @@ -182,6 +186,7 @@ <h1>Index</h1>
<li><code><a title="skema.program_analysis.tests.test_literal_returns" href="test_literal_returns.html">skema.program_analysis.tests.test_literal_returns</a></code></li>
<li><code><a title="skema.program_analysis.tests.test_loops" href="test_loops.html">skema.program_analysis.tests.test_loops</a></code></li>
<li><code><a title="skema.program_analysis.tests.test_model_coverage" href="test_model_coverage.html">skema.program_analysis.tests.test_model_coverage</a></code></li>
<li><code><a title="skema.program_analysis.tests.test_module_locate" href="test_module_locate.html">skema.program_analysis.tests.test_module_locate</a></code></li>
<li><code><a title="skema.program_analysis.tests.test_operation_cast" href="test_operation_cast.html">skema.program_analysis.tests.test_operation_cast</a></code></li>
<li><code><a title="skema.program_analysis.tests.test_primitive" href="test_primitive.html">skema.program_analysis.tests.test_primitive</a></code></li>
<li><code><a title="skema.program_analysis.tests.test_record_cast" href="test_record_cast.html">skema.program_analysis.tests.test_record_cast</a></code></li>
Expand Down
209 changes: 209 additions & 0 deletions api/python/skema/program_analysis/tests/test_module_locate.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,209 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>skema.program_analysis.tests.test_module_locate API documentation</title>
<meta name="description" content="" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script async src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS_CHTML" integrity="sha256-kZafAc6mZvK3W3v1pHOcUix30OHQN6pU/NO2oFkqZVw=" crossorigin></script>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>skema.program_analysis.tests.test_module_locate</code></h1>
</header>
<section id="section-intro">
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">import pytest
from unittest.mock import patch
from skema.program_analysis.module_locate import identify_source_type, module_locate

# Testing identify_source_type
@pytest.mark.parametrize(&#34;source,expected_type&#34;, [
(&#34;https://github.com/python/cpython&#34;, &#34;Compiled&#34;),
(&#34;https://github.com/other/repository&#34;, &#34;Repository&#34;),
(&#34;http://example.com&#34;, &#34;Url&#34;),
(&#34;local/path/to/module&#34;, &#34;Local&#34;),
(&#34;&#34;, &#34;Unknown&#34;),
])
def test_identify_source_type(source, expected_type):
assert identify_source_type(source) == expected_type

# Mocking requests.get to test module_locate without actual HTTP requests
@pytest.fixture
def mock_requests_get(mocker):
mock = mocker.patch(&#39;skema.program_analysis.module_locate.requests.get&#39;)
return mock

def test_module_locate_builtin_module():
assert module_locate(&#34;sys&#34;) == &#34;https://github.com/python/cpython&#34;

def test_module_locate_from_pypi_with_github_source(mock_requests_get):
mock_requests_get.return_value.json.return_value = {
&#39;info&#39;: {&#39;version&#39;: &#39;1.0.0&#39;, &#39;project_urls&#39;: {&#39;Source&#39;: &#39;https://github.com/example/project&#39;}},
&#39;releases&#39;: {&#39;1.0.0&#39;: [{&#39;filename&#39;: &#39;example-1.0.0.tar.gz&#39;, &#39;url&#39;: &#39;https://example.com/example-1.0.0.tar.gz&#39;}]}
}
assert module_locate(&#34;example&#34;) == &#34;https://github.com/example/project&#34;

def test_module_locate_from_pypi_with_tarball_url(mock_requests_get):
mock_requests_get.return_value.json.return_value = {
&#39;info&#39;: {&#39;version&#39;: &#39;1.2.3&#39;},
&#39;releases&#39;: {&#39;1.2.3&#39;: [{&#39;filename&#39;: &#39;package-1.2.3.tar.gz&#39;, &#39;url&#39;: &#39;https://pypi.org/package-1.2.3.tar.gz&#39;}]}
}
assert module_locate(&#34;package&#34;) == &#34;https://pypi.org/package-1.2.3.tar.gz&#34;

def test_module_locate_not_found(mock_requests_get):
mock_requests_get.side_effect = Exception(&#34;Module not found&#34;)
assert module_locate(&#34;nonexistent&#34;) is None</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="skema.program_analysis.tests.test_module_locate.mock_requests_get"><code class="name flex">
<span>def <span class="ident">mock_requests_get</span></span>(<span>mocker)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@pytest.fixture
def mock_requests_get(mocker):
mock = mocker.patch(&#39;skema.program_analysis.module_locate.requests.get&#39;)
return mock</code></pre>
</details>
</dd>
<dt id="skema.program_analysis.tests.test_module_locate.test_identify_source_type"><code class="name flex">
<span>def <span class="ident">test_identify_source_type</span></span>(<span>source, expected_type)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@pytest.mark.parametrize(&#34;source,expected_type&#34;, [
(&#34;https://github.com/python/cpython&#34;, &#34;Compiled&#34;),
(&#34;https://github.com/other/repository&#34;, &#34;Repository&#34;),
(&#34;http://example.com&#34;, &#34;Url&#34;),
(&#34;local/path/to/module&#34;, &#34;Local&#34;),
(&#34;&#34;, &#34;Unknown&#34;),
])
def test_identify_source_type(source, expected_type):
assert identify_source_type(source) == expected_type</code></pre>
</details>
</dd>
<dt id="skema.program_analysis.tests.test_module_locate.test_module_locate_builtin_module"><code class="name flex">
<span>def <span class="ident">test_module_locate_builtin_module</span></span>(<span>)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def test_module_locate_builtin_module():
assert module_locate(&#34;sys&#34;) == &#34;https://github.com/python/cpython&#34;</code></pre>
</details>
</dd>
<dt id="skema.program_analysis.tests.test_module_locate.test_module_locate_from_pypi_with_github_source"><code class="name flex">
<span>def <span class="ident">test_module_locate_from_pypi_with_github_source</span></span>(<span>mock_requests_get)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def test_module_locate_from_pypi_with_github_source(mock_requests_get):
mock_requests_get.return_value.json.return_value = {
&#39;info&#39;: {&#39;version&#39;: &#39;1.0.0&#39;, &#39;project_urls&#39;: {&#39;Source&#39;: &#39;https://github.com/example/project&#39;}},
&#39;releases&#39;: {&#39;1.0.0&#39;: [{&#39;filename&#39;: &#39;example-1.0.0.tar.gz&#39;, &#39;url&#39;: &#39;https://example.com/example-1.0.0.tar.gz&#39;}]}
}
assert module_locate(&#34;example&#34;) == &#34;https://github.com/example/project&#34;</code></pre>
</details>
</dd>
<dt id="skema.program_analysis.tests.test_module_locate.test_module_locate_from_pypi_with_tarball_url"><code class="name flex">
<span>def <span class="ident">test_module_locate_from_pypi_with_tarball_url</span></span>(<span>mock_requests_get)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def test_module_locate_from_pypi_with_tarball_url(mock_requests_get):
mock_requests_get.return_value.json.return_value = {
&#39;info&#39;: {&#39;version&#39;: &#39;1.2.3&#39;},
&#39;releases&#39;: {&#39;1.2.3&#39;: [{&#39;filename&#39;: &#39;package-1.2.3.tar.gz&#39;, &#39;url&#39;: &#39;https://pypi.org/package-1.2.3.tar.gz&#39;}]}
}
assert module_locate(&#34;package&#34;) == &#34;https://pypi.org/package-1.2.3.tar.gz&#34;</code></pre>
</details>
</dd>
<dt id="skema.program_analysis.tests.test_module_locate.test_module_locate_not_found"><code class="name flex">
<span>def <span class="ident">test_module_locate_not_found</span></span>(<span>mock_requests_get)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def test_module_locate_not_found(mock_requests_get):
mock_requests_get.side_effect = Exception(&#34;Module not found&#34;)
assert module_locate(&#34;nonexistent&#34;) is None</code></pre>
</details>
</dd>
</dl>
</section>
<section>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="skema.program_analysis.tests" href="index.html">skema.program_analysis.tests</a></code></li>
</ul>
</li>
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="skema.program_analysis.tests.test_module_locate.mock_requests_get" href="#skema.program_analysis.tests.test_module_locate.mock_requests_get">mock_requests_get</a></code></li>
<li><code><a title="skema.program_analysis.tests.test_module_locate.test_identify_source_type" href="#skema.program_analysis.tests.test_module_locate.test_identify_source_type">test_identify_source_type</a></code></li>
<li><code><a title="skema.program_analysis.tests.test_module_locate.test_module_locate_builtin_module" href="#skema.program_analysis.tests.test_module_locate.test_module_locate_builtin_module">test_module_locate_builtin_module</a></code></li>
<li><code><a title="skema.program_analysis.tests.test_module_locate.test_module_locate_from_pypi_with_github_source" href="#skema.program_analysis.tests.test_module_locate.test_module_locate_from_pypi_with_github_source">test_module_locate_from_pypi_with_github_source</a></code></li>
<li><code><a title="skema.program_analysis.tests.test_module_locate.test_module_locate_from_pypi_with_tarball_url" href="#skema.program_analysis.tests.test_module_locate.test_module_locate_from_pypi_with_tarball_url">test_module_locate_from_pypi_with_tarball_url</a></code></li>
<li><code><a title="skema.program_analysis.tests.test_module_locate.test_module_locate_not_found" href="#skema.program_analysis.tests.test_module_locate.test_module_locate_not_found">test_module_locate_not_found</a></code></li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
</footer>
</body>
</html>
Loading

0 comments on commit 8d7bee0

Please sign in to comment.