Skip to content

Commit eea110f

Browse files
committed
Memoryview
1 parent c5bfdb0 commit eea110f

File tree

2 files changed

+14
-10
lines changed

2 files changed

+14
-10
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1957,18 +1957,21 @@ Memory View
19571957

19581958
```python
19591959
<mview> = memoryview(<bytes/bytearray/array>)
1960-
<num> = <mview>[<index>] # Can be int or float.
1960+
<num> = <mview>[<index>] # Returns an int or a float.
19611961
<mview> = <mview>[<slice>] # Mview with rearranged elements.
19621962
<mview> = <mview>.cast('<typecode>') # Casts a memoryview to a new format.
19631963
<mview>.release() # Releases the object's memory buffer.
19641964
```
19651965

19661966
```python
1967-
<bin_file>.write(<mview>)
1968-
<bytes> = bytes(<mview>) # Or: <mview>.tobytes()
1967+
<bin_file>.write(<mview>) # Writes mview to a binary file.
1968+
<bytes> = bytes(<mview>) # Creates a new bytes object.
19691969
<bytes> = <bytes>.join(<coll_of_mviews>) # Joins mviews using bytes object as sep.
1970-
<list> = list(<mview>) # Returns numbers. Or: <mview>.tolist()
1971-
<str> = str(<mview>, 'utf-8') # Or: <bytes>.decode('utf-8')
1970+
```
1971+
1972+
```python
1973+
<list> = list(<mview>) # Returns list of ints or floats.
1974+
<str> = str(<mview>, 'utf-8')
19721975
<int> = int.from_bytes(<mview>, byteorder='big|little', signed=False)
19731976
'<hex>' = <mview>.hex()
19741977
```

index.html

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1734,18 +1734,19 @@
17341734
<li><strong>Each element can reference a single or multiple consecutive bytes, depending on format.</strong></li>
17351735
<li><strong>Order and number of elements can be changed with slicing.</strong></li>
17361736
</ul><pre><code class="python language-python hljs">&lt;mview&gt; = memoryview(&lt;bytes/bytearray/array&gt;)
1737-
&lt;num&gt; = &lt;mview&gt;[&lt;index&gt;] <span class="hljs-comment"># Can be int or float.</span>
1737+
&lt;num&gt; = &lt;mview&gt;[&lt;index&gt;] <span class="hljs-comment"># Returns an int or a float.</span>
17381738
&lt;mview&gt; = &lt;mview&gt;[&lt;slice&gt;] <span class="hljs-comment"># Mview with rearranged elements.</span>
17391739
&lt;mview&gt; = &lt;mview&gt;.cast(<span class="hljs-string">'&lt;typecode&gt;'</span>) <span class="hljs-comment"># Casts a memoryview to a new format.</span>
17401740
&lt;mview&gt;.release() <span class="hljs-comment"># Releases the object's memory buffer.</span>
17411741
</code></pre></div>
17421742

17431743

1744-
<pre><code class="python language-python hljs">&lt;bin_file&gt;.write(&lt;mview&gt;)
1745-
&lt;bytes&gt; = bytes(&lt;mview&gt;) <span class="hljs-comment"># Or: &lt;mview&gt;.tobytes()</span>
1744+
<pre><code class="python language-python hljs">&lt;bin_file&gt;.write(&lt;mview&gt;) <span class="hljs-comment"># Writes mview to a binary file.</span>
1745+
&lt;bytes&gt; = bytes(&lt;mview&gt;) <span class="hljs-comment"># Creates a new bytes object.</span>
17461746
&lt;bytes&gt; = &lt;bytes&gt;.join(&lt;coll_of_mviews&gt;) <span class="hljs-comment"># Joins mviews using bytes object as sep.</span>
1747-
&lt;list&gt; = list(&lt;mview&gt;) <span class="hljs-comment"># Returns numbers. Or: &lt;mview&gt;.tolist()</span>
1748-
&lt;str&gt; = str(&lt;mview&gt;, <span class="hljs-string">'utf-8'</span>) <span class="hljs-comment"># Or: &lt;bytes&gt;.decode('utf-8')</span>
1747+
</code></pre>
1748+
<pre><code class="python language-python hljs">&lt;list&gt; = list(&lt;mview&gt;) <span class="hljs-comment"># Returns list of ints or floats.</span>
1749+
&lt;str&gt; = str(&lt;mview&gt;, <span class="hljs-string">'utf-8'</span>)
17491750
&lt;int&gt; = int.from_bytes(&lt;mview&gt;, byteorder=<span class="hljs-string">'big|little'</span>, signed=<span class="hljs-keyword">False</span>)
17501751
<span class="hljs-string">'&lt;hex&gt;'</span> = &lt;mview&gt;.hex()
17511752
</code></pre>

0 commit comments

Comments
 (0)