Skip to content

Commit

Permalink
Deploying to gh-pages from @ 3e2a031 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
mlissner committed Jul 22, 2022
1 parent 294a9cb commit 460a7d7
Show file tree
Hide file tree
Showing 3 changed files with 68 additions and 17 deletions.
2 changes: 1 addition & 1 deletion annotate.html
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ <h1 class="title">Module <code>eyecite.annotate</code></h1>
&#34;&#34;&#34;
try:
return fast_diff_match_patch.diff(
a, b, timelimit=0, checklines=False, cleanup=&#34;No&#34;,
a, b, timelimit=0, checklines=False, cleanup=&#34;No&#34;
)
except AttributeError as e:
raise AttributeError(
Expand Down
76 changes: 60 additions & 16 deletions models.html
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,9 @@ <h1 class="title">Module <code>eyecite.models</code></h1>
if isinstance(self.metadata, dict)
else self.Metadata()
)
# Set known missing page numbers to None
if re.search(&#34;^_+$&#34;, self.groups.get(&#34;page&#34;, &#34;&#34;) or &#34;&#34;):
self.groups[&#34;page&#34;] = None

def __repr__(self):
&#34;&#34;&#34;Simplified repr() to be more readable than full dataclass repr().
Expand All @@ -131,8 +134,12 @@ <h1 class="title">Module <code>eyecite.models</code></h1>

def comparison_hash(self) -&gt; int:
&#34;&#34;&#34;Return hash that will be the same if two cites are semantically
equivalent.&#34;&#34;&#34;
return hash((type(self), tuple(self.groups.items())))
equivalent, unless the citation is a CaseCitation missing a page.
&#34;&#34;&#34;
if isinstance(self, CaseCitation) and self.groups[&#34;page&#34;] is None:
return id(self)
else:
return hash((type(self), tuple(self.groups.items())))

def corrected_citation(self):
&#34;&#34;&#34;Return citation with any variations normalized.&#34;&#34;&#34;
Expand Down Expand Up @@ -642,7 +649,12 @@ <h1 class="title">Module <code>eyecite.models</code></h1>

def __hash__(self):
&#34;&#34;&#34;Resources are the same if their citations are semantically
equivalent.&#34;&#34;&#34;
equivalent.

Note: Resources composed of citations with missing page numbers are
NOT considered the same, even if their other attributes are identical.
This is to avoid potential false positives.
&#34;&#34;&#34;
return self.citation.comparison_hash()

def __eq__(self, other):
Expand Down Expand Up @@ -771,7 +783,7 @@ <h3>Inherited members</h3>
<ul class="hlist">
<li><code><a title="eyecite.models.ResourceCitation.Metadata" href="#eyecite.models.CitationBase.Metadata">Metadata</a></code></li>
<li><code><a title="eyecite.models.ResourceCitation.add_metadata" href="#eyecite.models.ResourceCitation.add_metadata">add_metadata</a></code></li>
<li><code><a title="eyecite.models.ResourceCitation.comparison_hash" href="#eyecite.models.CitationBase.comparison_hash">comparison_hash</a></code></li>
<li><code><a title="eyecite.models.ResourceCitation.comparison_hash" href="#eyecite.models.ResourceCitation.comparison_hash">comparison_hash</a></code></li>
<li><code><a title="eyecite.models.ResourceCitation.corrected_citation" href="#eyecite.models.ResourceCitation.corrected_citation">corrected_citation</a></code></li>
<li><code><a title="eyecite.models.ResourceCitation.corrected_citation_full" href="#eyecite.models.CitationBase.corrected_citation_full">corrected_citation_full</a></code></li>
<li><code><a title="eyecite.models.ResourceCitation.corrected_reporter" href="#eyecite.models.ResourceCitation.corrected_reporter">corrected_reporter</a></code></li>
Expand Down Expand Up @@ -818,6 +830,9 @@ <h3>Inherited members</h3>
if isinstance(self.metadata, dict)
else self.Metadata()
)
# Set known missing page numbers to None
if re.search(&#34;^_+$&#34;, self.groups.get(&#34;page&#34;, &#34;&#34;) or &#34;&#34;):
self.groups[&#34;page&#34;] = None

def __repr__(self):
&#34;&#34;&#34;Simplified repr() to be more readable than full dataclass repr().
Expand All @@ -838,8 +853,12 @@ <h3>Inherited members</h3>

def comparison_hash(self) -&gt; int:
&#34;&#34;&#34;Return hash that will be the same if two cites are semantically
equivalent.&#34;&#34;&#34;
return hash((type(self), tuple(self.groups.items())))
equivalent, unless the citation is a CaseCitation missing a page.
&#34;&#34;&#34;
if isinstance(self, CaseCitation) and self.groups[&#34;page&#34;] is None:
return id(self)
else:
return hash((type(self), tuple(self.groups.items())))

def corrected_citation(self):
&#34;&#34;&#34;Return citation with any variations normalized.&#34;&#34;&#34;
Expand Down Expand Up @@ -919,15 +938,19 @@ <h3>Methods</h3>
</code></dt>
<dd>
<div class="desc"><p>Return hash that will be the same if two cites are semantically
equivalent.</p></div>
equivalent, unless the citation is a CaseCitation missing a page.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def comparison_hash(self) -&gt; int:
&#34;&#34;&#34;Return hash that will be the same if two cites are semantically
equivalent.&#34;&#34;&#34;
return hash((type(self), tuple(self.groups.items())))</code></pre>
equivalent, unless the citation is a CaseCitation missing a page.
&#34;&#34;&#34;
if isinstance(self, CaseCitation) and self.groups[&#34;page&#34;] is None:
return id(self)
else:
return hash((type(self), tuple(self.groups.items())))</code></pre>
</details>
</dd>
<dt id="eyecite.models.CitationBase.corrected_citation"><code class="name flex">
Expand Down Expand Up @@ -1325,7 +1348,7 @@ <h3>Inherited members</h3>
<ul class="hlist">
<li><code><a title="eyecite.models.CaseCitation.Metadata" href="#eyecite.models.CitationBase.Metadata">Metadata</a></code></li>
<li><code><a title="eyecite.models.CaseCitation.add_metadata" href="#eyecite.models.ResourceCitation.add_metadata">add_metadata</a></code></li>
<li><code><a title="eyecite.models.CaseCitation.comparison_hash" href="#eyecite.models.CitationBase.comparison_hash">comparison_hash</a></code></li>
<li><code><a title="eyecite.models.CaseCitation.comparison_hash" href="#eyecite.models.ResourceCitation.comparison_hash">comparison_hash</a></code></li>
<li><code><a title="eyecite.models.CaseCitation.corrected_citation" href="#eyecite.models.ResourceCitation.corrected_citation">corrected_citation</a></code></li>
<li><code><a title="eyecite.models.CaseCitation.corrected_reporter" href="#eyecite.models.ResourceCitation.corrected_reporter">corrected_reporter</a></code></li>
<li><code><a title="eyecite.models.CaseCitation.dump" href="#eyecite.models.CitationBase.dump">dump</a></code></li>
Expand Down Expand Up @@ -1392,7 +1415,7 @@ <h3>Inherited members</h3>
<ul class="hlist">
<li><code><a title="eyecite.models.ResourceCitation.Metadata" href="#eyecite.models.CitationBase.Metadata">Metadata</a></code></li>
<li><code><a title="eyecite.models.ResourceCitation.add_metadata" href="#eyecite.models.ResourceCitation.add_metadata">add_metadata</a></code></li>
<li><code><a title="eyecite.models.ResourceCitation.comparison_hash" href="#eyecite.models.CitationBase.comparison_hash">comparison_hash</a></code></li>
<li><code><a title="eyecite.models.ResourceCitation.comparison_hash" href="#eyecite.models.ResourceCitation.comparison_hash">comparison_hash</a></code></li>
<li><code><a title="eyecite.models.ResourceCitation.corrected_citation" href="#eyecite.models.ResourceCitation.corrected_citation">corrected_citation</a></code></li>
<li><code><a title="eyecite.models.ResourceCitation.corrected_citation_full" href="#eyecite.models.CitationBase.corrected_citation_full">corrected_citation_full</a></code></li>
<li><code><a title="eyecite.models.ResourceCitation.corrected_reporter" href="#eyecite.models.ResourceCitation.corrected_reporter">corrected_reporter</a></code></li>
Expand Down Expand Up @@ -1473,7 +1496,7 @@ <h3>Inherited members</h3>
<ul class="hlist">
<li><code><a title="eyecite.models.FullCitation.Metadata" href="#eyecite.models.CitationBase.Metadata">Metadata</a></code></li>
<li><code><a title="eyecite.models.FullCitation.add_metadata" href="#eyecite.models.ResourceCitation.add_metadata">add_metadata</a></code></li>
<li><code><a title="eyecite.models.FullCitation.comparison_hash" href="#eyecite.models.CitationBase.comparison_hash">comparison_hash</a></code></li>
<li><code><a title="eyecite.models.FullCitation.comparison_hash" href="#eyecite.models.ResourceCitation.comparison_hash">comparison_hash</a></code></li>
<li><code><a title="eyecite.models.FullCitation.corrected_citation" href="#eyecite.models.ResourceCitation.corrected_citation">corrected_citation</a></code></li>
<li><code><a title="eyecite.models.FullCitation.corrected_citation_full" href="#eyecite.models.CitationBase.corrected_citation_full">corrected_citation_full</a></code></li>
<li><code><a title="eyecite.models.FullCitation.corrected_reporter" href="#eyecite.models.ResourceCitation.corrected_reporter">corrected_reporter</a></code></li>
Expand Down Expand Up @@ -1565,7 +1588,7 @@ <h3>Inherited members</h3>
<ul class="hlist">
<li><code><a title="eyecite.models.FullCitation.Metadata" href="#eyecite.models.CitationBase.Metadata">Metadata</a></code></li>
<li><code><a title="eyecite.models.FullCitation.add_metadata" href="#eyecite.models.ResourceCitation.add_metadata">add_metadata</a></code></li>
<li><code><a title="eyecite.models.FullCitation.comparison_hash" href="#eyecite.models.CitationBase.comparison_hash">comparison_hash</a></code></li>
<li><code><a title="eyecite.models.FullCitation.comparison_hash" href="#eyecite.models.ResourceCitation.comparison_hash">comparison_hash</a></code></li>
<li><code><a title="eyecite.models.FullCitation.corrected_citation" href="#eyecite.models.ResourceCitation.corrected_citation">corrected_citation</a></code></li>
<li><code><a title="eyecite.models.FullCitation.corrected_citation_full" href="#eyecite.models.CitationBase.corrected_citation_full">corrected_citation_full</a></code></li>
<li><code><a title="eyecite.models.FullCitation.corrected_reporter" href="#eyecite.models.ResourceCitation.corrected_reporter">corrected_reporter</a></code></li>
Expand Down Expand Up @@ -1856,7 +1879,12 @@ <h3>Class variables</h3>

def __hash__(self):
&#34;&#34;&#34;Resources are the same if their citations are semantically
equivalent.&#34;&#34;&#34;
equivalent.

Note: Resources composed of citations with missing page numbers are
NOT considered the same, even if their other attributes are identical.
This is to avoid potential false positives.
&#34;&#34;&#34;
return self.citation.comparison_hash()

def __eq__(self, other):
Expand Down Expand Up @@ -2010,6 +2038,22 @@ <h3>Methods</h3>
self.guess_edition()</code></pre>
</details>
</dd>
<dt id="eyecite.models.ResourceCitation.comparison_hash"><code class="name flex">
<span>def <span class="ident">comparison_hash</span></span>(<span>self) ‑> int</span>
</code></dt>
<dd>
<div class="desc"><p>Return hash that will be the same if two cites are semantically
equivalent.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def comparison_hash(self) -&gt; int:
&#34;&#34;&#34;Return hash that will be the same if two cites are semantically
equivalent.&#34;&#34;&#34;
return hash((super().comparison_hash(), self.all_editions))</code></pre>
</details>
</dd>
<dt id="eyecite.models.ResourceCitation.corrected_citation"><code class="name flex">
<span>def <span class="ident">corrected_citation</span></span>(<span>self)</span>
</code></dt>
Expand Down Expand Up @@ -2076,7 +2120,6 @@ <h3>Inherited members</h3>
<li><code><b><a title="eyecite.models.CitationBase" href="#eyecite.models.CitationBase">CitationBase</a></b></code>:
<ul class="hlist">
<li><code><a title="eyecite.models.CitationBase.Metadata" href="#eyecite.models.CitationBase.Metadata">Metadata</a></code></li>
<li><code><a title="eyecite.models.CitationBase.comparison_hash" href="#eyecite.models.CitationBase.comparison_hash">comparison_hash</a></code></li>
<li><code><a title="eyecite.models.CitationBase.corrected_citation_full" href="#eyecite.models.CitationBase.corrected_citation_full">corrected_citation_full</a></code></li>
<li><code><a title="eyecite.models.CitationBase.dump" href="#eyecite.models.CitationBase.dump">dump</a></code></li>
<li><code><a title="eyecite.models.CitationBase.matched_text" href="#eyecite.models.CitationBase.matched_text">matched_text</a></code></li>
Expand Down Expand Up @@ -2240,7 +2283,7 @@ <h3>Inherited members</h3>
<ul class="hlist">
<li><code><a title="eyecite.models.CaseCitation.Metadata" href="#eyecite.models.CitationBase.Metadata">Metadata</a></code></li>
<li><code><a title="eyecite.models.CaseCitation.add_metadata" href="#eyecite.models.ResourceCitation.add_metadata">add_metadata</a></code></li>
<li><code><a title="eyecite.models.CaseCitation.comparison_hash" href="#eyecite.models.CitationBase.comparison_hash">comparison_hash</a></code></li>
<li><code><a title="eyecite.models.CaseCitation.comparison_hash" href="#eyecite.models.ResourceCitation.comparison_hash">comparison_hash</a></code></li>
<li><code><a title="eyecite.models.CaseCitation.corrected_citation" href="#eyecite.models.ResourceCitation.corrected_citation">corrected_citation</a></code></li>
<li><code><a title="eyecite.models.CaseCitation.corrected_reporter" href="#eyecite.models.ResourceCitation.corrected_reporter">corrected_reporter</a></code></li>
<li><code><a title="eyecite.models.CaseCitation.dump" href="#eyecite.models.CitationBase.dump">dump</a></code></li>
Expand Down Expand Up @@ -2966,6 +3009,7 @@ <h4><code><a title="eyecite.models.ResourceCitation" href="#eyecite.models.Resou
<ul class="two-column">
<li><code><a title="eyecite.models.ResourceCitation.add_metadata" href="#eyecite.models.ResourceCitation.add_metadata">add_metadata</a></code></li>
<li><code><a title="eyecite.models.ResourceCitation.all_editions" href="#eyecite.models.ResourceCitation.all_editions">all_editions</a></code></li>
<li><code><a title="eyecite.models.ResourceCitation.comparison_hash" href="#eyecite.models.ResourceCitation.comparison_hash">comparison_hash</a></code></li>
<li><code><a title="eyecite.models.ResourceCitation.corrected_citation" href="#eyecite.models.ResourceCitation.corrected_citation">corrected_citation</a></code></li>
<li><code><a title="eyecite.models.ResourceCitation.corrected_reporter" href="#eyecite.models.ResourceCitation.corrected_reporter">corrected_reporter</a></code></li>
<li><code><a title="eyecite.models.ResourceCitation.edition_guess" href="#eyecite.models.ResourceCitation.edition_guess">edition_guess</a></code></li>
Expand Down
7 changes: 7 additions & 0 deletions resolve.html
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,13 @@ <h1 class="title">Module <code>eyecite.resolve</code></h1>
) -&gt; bool:
&#34;&#34;&#34;Return True if id_cite has a pin cite that can&#39;t be correct for the
given full_cite.&#34;&#34;&#34;
# if full cite has a known missing page, this pin cite can&#39;t be correct
if (
type(full_cite) is FullCaseCitation
and full_cite.groups.get(&#34;page&#34;) is None
):
return True

# if no pin cite, we&#39;re fine
if not id_cite.metadata.pin_cite:
return False
Expand Down

0 comments on commit 460a7d7

Please sign in to comment.