<?xml version="1.0" encoding="UTF-8"?><rss xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:atom="http://www.w3.org/2005/Atom" version="2.0"><channel><title><![CDATA[Mising documentation for uos.stat()]]></title><description><![CDATA[<p dir="auto">One of the LoPy issues is the really poor documentation. There are lot of information missing or if it looks like documented in fact unusable. Not the only one but I faced recently the explanation uos.stat() return values :(</p>
<p dir="auto">Why the Hell I have to do reverse engineering to use a commercial product?</p>
<p dir="auto"><a href="https://docs.pycom.io/pycom_esp32/library/uos.html#uos.stat" target="_blank" rel="noopener noreferrer nofollow">https://docs.pycom.io/pycom_esp32/library/uos.html#uos.stat</a></p>
]]></description><link>https://forum.pycom.io/topic/380/mising-documentation-for-uos-stat</link><generator>RSS for Node</generator><lastBuildDate>Mon, 08 Jun 2026 08:46:50 GMT</lastBuildDate><atom:link href="https://forum.pycom.io/topic/380.rss" rel="self" type="application/rss+xml"/><pubDate>Sun, 18 Dec 2016 15:52:49 GMT</pubDate><ttl>60</ttl><item><title><![CDATA[Reply to Mising documentation for uos.stat() on Sun, 18 Dec 2016 15:53:35 GMT]]></title><description><![CDATA[<p dir="auto">One of the LoPy issues is the really poor documentation. There are lot of information missing or if it looks like documented in fact unusable. Not the only one but I faced recently the explanation uos.stat() return values :(</p>
<p dir="auto">Why the Hell I have to do reverse engineering to use a commercial product?</p>
<p dir="auto"><a href="https://docs.pycom.io/pycom_esp32/library/uos.html#uos.stat" target="_blank" rel="noopener noreferrer nofollow">https://docs.pycom.io/pycom_esp32/library/uos.html#uos.stat</a></p>
]]></description><link>https://forum.pycom.io/post/2281</link><guid isPermaLink="true">https://forum.pycom.io/post/2281</guid><dc:creator><![CDATA[bmarkus]]></dc:creator><pubDate>Sun, 18 Dec 2016 15:53:35 GMT</pubDate></item><item><title><![CDATA[Reply to Mising documentation for uos.stat() on Mon, 19 Dec 2016 14:27:47 GMT]]></title><description><![CDATA[<p dir="auto">Hello,</p>
<p dir="auto">This is standard micropython documentation and the returned values are actually documented in standard Python: <a href="https://docs.python.org/2/library/errno.html#module-errno" target="_blank" rel="noopener noreferrer nofollow">https://docs.python.org/2/library/errno.html#module-errno</a></p>
<p dir="auto">Does that help?</p>
]]></description><link>https://forum.pycom.io/post/2308</link><guid isPermaLink="true">https://forum.pycom.io/post/2308</guid><dc:creator><![CDATA[sakis]]></dc:creator><pubDate>Mon, 19 Dec 2016 14:27:47 GMT</pubDate></item><item><title><![CDATA[Reply to Mising documentation for uos.stat() on Mon, 19 Dec 2016 15:28:39 GMT]]></title><description><![CDATA[<p dir="auto"><a class="plugin-mentions-user plugin-mentions-a" href="https://forum.pycom.io/uid/32">@sakis</a> said in <a href="/post/2308">Mising documentation for uos.stat()</a>:</p>
<blockquote>
<p dir="auto">Hello,</p>
<p dir="auto">This is standard micropython documentation and the returned values are actually documented in standard Python: <a href="https://docs.python.org/2/library/errno.html#module-errno" target="_blank" rel="noopener noreferrer nofollow">https://docs.python.org/2/library/errno.html#module-errno</a></p>
<p dir="auto">Does that help?</p>
</blockquote>
<p dir="auto">Why are you referring to the error codes?</p>
<p dir="auto">In the Pycom doc there is nothing about return values. Without describing return values for a function it is not a documentation. You can say 'It is the same as in cPython' but even in this case why to refer to an external documention in your own doc?</p>
<p dir="auto">As a developer, do you like to work with a product with useless documentation, unmet commitments, misleading brochures and product descriptions with missing features based on unstable beta hardware where even no any warranty that hw vendor will fix issues and no ETA it will ever work on acceptable level?<br />
As a hobby DIY constructor you can play with such board in the evening in your free time but no way to use it for a product.</p>
<p dir="auto">You can say it is up to the hw vendor which is probably true. But to release a product based on alpha unproven silicon with alpha fw is a bad decision op Pycom. During the last few month your documentation structure is still messy and nearly unusable. Yesterday I was looking for the documentation and at <a href="http://pycom.io" target="_blank" rel="noopener noreferrer nofollow">pycom.io</a> site there are no single menu item for docs. You do not have to reinvent the wheel, just do what others are doing well. Not referring to big guns, but other KickStarters with similar products providing excellent docs.</p>
<p dir="auto">I'm really unhappy and fior sure will never buy any Pycom product and do not advice others to do it.</p>
]]></description><link>https://forum.pycom.io/post/2321</link><guid isPermaLink="true">https://forum.pycom.io/post/2321</guid><dc:creator><![CDATA[bmarkus]]></dc:creator><pubDate>Mon, 19 Dec 2016 15:28:39 GMT</pubDate></item><item><title><![CDATA[Reply to Mising documentation for uos.stat() on Mon, 19 Dec 2016 15:47:03 GMT]]></title><description><![CDATA[<p dir="auto"><a class="plugin-mentions-user plugin-mentions-a" href="https://forum.pycom.io/uid/110">@bmarkus</a></p>
<p dir="auto">The Pycom doc parts that refer to MicroPython are not modified to allow future merging. Here's the original MicroPython doc of <code>uos.stat</code>: <a href="http://docs.micropython.org/en/latest/pyboard/library/uos.html#uos.stat" target="_blank" rel="noopener noreferrer nofollow">http://docs.micropython.org/en/latest/pyboard/library/uos.html#uos.stat</a>. As you see, there's nothing there. That's what I meant by standard MicroPython documentation. Perhaps we should improve the documentation of that function in our docs.</p>
<p dir="auto">Without being the creator of MicroPython, I think that the fact that it is a port of Python 3 for microcontrollers means that the error codes of a function like <code>stat</code> must be the same (or at least close) to the error codes of standard Python. That's why I referred to Python's documentation.</p>
<p dir="auto">About your rest points, I agree that a docs link should be added to <a href="http://pycom.io" target="_blank" rel="noopener noreferrer nofollow">pycom.io</a>. And we are trying hard to improve both our documentation and our firmware.</p>
<p dir="auto">Sorry to hear about your disappointment. I hope that we can change your mind.</p>
]]></description><link>https://forum.pycom.io/post/2327</link><guid isPermaLink="true">https://forum.pycom.io/post/2327</guid><dc:creator><![CDATA[sakis]]></dc:creator><pubDate>Mon, 19 Dec 2016 15:47:03 GMT</pubDate></item><item><title><![CDATA[Reply to Mising documentation for uos.stat() on Mon, 09 Jan 2017 06:22:44 GMT]]></title><description><![CDATA[<p dir="auto"><a class="plugin-mentions-user plugin-mentions-a" href="https://forum.pycom.io/uid/32">@sakis</a><br />
I see that you mention that you are not creator of micropython...<br />
but in normal python os.stat return object<br />
<code>class os.stat_result</code><br />
but here it return <code>touple</code> without any description<br />
e.g.:</p>
<pre><code>&gt;&gt;&gt; os.stat('/sd')
(16384, 0, 0, 0, 0, 0, 0, 12873600, 12873600, 12873600)
</code></pre>
<p dir="auto">what are that values?<br />
i need to know how big is sd card, free space ...</p>
]]></description><link>https://forum.pycom.io/post/2796</link><guid isPermaLink="true">https://forum.pycom.io/post/2796</guid><dc:creator><![CDATA[livius]]></dc:creator><pubDate>Mon, 09 Jan 2017 06:22:44 GMT</pubDate></item><item><title><![CDATA[Reply to Mising documentation for uos.stat() on Mon, 09 Jan 2017 06:38:47 GMT]]></title><description><![CDATA[<p dir="auto"><a class="plugin-mentions-user plugin-mentions-a" href="https://forum.pycom.io/uid/32">@sakis</a> said in <a href="/post/2327">Mising documentation for uos.stat()</a>:</p>
<blockquote>
<p dir="auto"><a class="plugin-mentions-user plugin-mentions-a" href="https://forum.pycom.io/uid/110">@bmarkus</a></p>
<p dir="auto">About your rest points, I agree that a docs link should be added to <a href="http://pycom.io" target="_blank" rel="noopener noreferrer nofollow">pycom.io</a>. And we are trying hard to improve both our documentation and our firmware.</p>
</blockquote>
<p dir="auto">After 21 days Pycom doc looks the same at <a href="https://docs.pycom.io/pycom_esp32/library/uos.html" target="_blank" rel="noopener noreferrer nofollow">https://docs.pycom.io/pycom_esp32/library/uos.html</a></p>
<p dir="auto">saying only</p>
<p dir="auto"><em>Get the status of a file or directory.</em></p>
<p dir="auto">So, question is still valid, what is the return value? It is a question related to your own commercial product, not related to chip vendor, LoRa Alliance, CIA, KGB, ...</p>
<p dir="auto">What is about making a product usable for its customers and provide documentation? How do you expect to use it (expecting we get some free RAM and stable functions instead of changing it every week, introducing new bugs, etc.)?</p>
]]></description><link>https://forum.pycom.io/post/2797</link><guid isPermaLink="true">https://forum.pycom.io/post/2797</guid><dc:creator><![CDATA[bmarkus]]></dc:creator><pubDate>Mon, 09 Jan 2017 06:38:47 GMT</pubDate></item><item><title><![CDATA[Reply to Mising documentation for uos.stat() on Mon, 09 Jan 2017 08:42:03 GMT]]></title><description><![CDATA[<p dir="auto"><a class="plugin-mentions-user plugin-mentions-a" href="https://forum.pycom.io/uid/110">@bmarkus</a> <a class="plugin-mentions-user plugin-mentions-a" href="https://forum.pycom.io/uid/199">@livius</a></p>
<p dir="auto">Fair points. We are planning to release an update to our documentation this week and documenting the return values of <code>os.stat</code> will be part of it.</p>
]]></description><link>https://forum.pycom.io/post/2802</link><guid isPermaLink="true">https://forum.pycom.io/post/2802</guid><dc:creator><![CDATA[sakis]]></dc:creator><pubDate>Mon, 09 Jan 2017 08:42:03 GMT</pubDate></item><item><title><![CDATA[Reply to Mising documentation for uos.stat() on Mon, 09 Jan 2017 08:42:27 GMT]]></title><description><![CDATA[<p dir="auto">The returned tuple has the structure defined for Python3 os.stat(). Only not all values are populated. useful values are:<br />
ST_MODE<br />
ST_SIZE<br />
ST_ATIME which is teh same as ST_MTIME and ST_CTIME<br />
The other values are set to zero, since they do not apply in the given environment, but the full structure is returned for compatibility.<br />
No reason to complain. If there is not special documentation, assume Python compliance as a plausible choice.</p>
]]></description><link>https://forum.pycom.io/post/2803</link><guid isPermaLink="true">https://forum.pycom.io/post/2803</guid><dc:creator><![CDATA[robert-hh]]></dc:creator><pubDate>Mon, 09 Jan 2017 08:42:27 GMT</pubDate></item><item><title><![CDATA[Reply to Mising documentation for uos.stat() on Mon, 09 Jan 2017 08:49:52 GMT]]></title><description><![CDATA[<p dir="auto"><a class="plugin-mentions-user plugin-mentions-a" href="https://forum.pycom.io/uid/98">@robert-hh</a> said in <a href="/post/2803">Mising documentation for uos.stat()</a>:</p>
<p dir="auto">it work for you in that way?<br />
like <code>os.stat().ST_SIZE</code>?</p>
<p dir="auto">i must check this at home - i tested this previously and i remember that it does not know ST_SIZE</p>
]]></description><link>https://forum.pycom.io/post/2805</link><guid isPermaLink="true">https://forum.pycom.io/post/2805</guid><dc:creator><![CDATA[livius]]></dc:creator><pubDate>Mon, 09 Jan 2017 08:49:52 GMT</pubDate></item><item><title><![CDATA[Reply to Mising documentation for uos.stat() on Mon, 09 Jan 2017 08:58:22 GMT]]></title><description><![CDATA[<p dir="auto">No, not that way. os.stat() return a 10-tuple, and the 7th, os_stat()[6], is the size. The symbolic indices are NOT set.</p>
]]></description><link>https://forum.pycom.io/post/2807</link><guid isPermaLink="true">https://forum.pycom.io/post/2807</guid><dc:creator><![CDATA[robert-hh]]></dc:creator><pubDate>Mon, 09 Jan 2017 08:58:22 GMT</pubDate></item><item><title><![CDATA[Reply to Mising documentation for uos.stat() on Mon, 09 Jan 2017 09:00:42 GMT]]></title><description><![CDATA[<p dir="auto"><a class="plugin-mentions-user plugin-mentions-a" href="https://forum.pycom.io/uid/98">@robert-hh</a> said in <a href="/post/2807">Mising documentation for uos.stat()</a>:</p>
<blockquote>
<p dir="auto">The symbolic indices are NOT set.</p>
</blockquote>
<p dir="auto">and that is the point</p>
]]></description><link>https://forum.pycom.io/post/2809</link><guid isPermaLink="true">https://forum.pycom.io/post/2809</guid><dc:creator><![CDATA[livius]]></dc:creator><pubDate>Mon, 09 Jan 2017 09:00:42 GMT</pubDate></item><item><title><![CDATA[Reply to Mising documentation for uos.stat() on Mon, 09 Jan 2017 09:04:55 GMT]]></title><description><![CDATA[<p dir="auto">This is a Micro, fighting for every byte for memory. Too many features make it unusable.</p>
]]></description><link>https://forum.pycom.io/post/2811</link><guid isPermaLink="true">https://forum.pycom.io/post/2811</guid><dc:creator><![CDATA[robert-hh]]></dc:creator><pubDate>Mon, 09 Jan 2017 09:04:55 GMT</pubDate></item><item><title><![CDATA[Reply to Mising documentation for uos.stat() on Mon, 09 Jan 2017 09:25:51 GMT]]></title><description><![CDATA[<p dir="auto"><a class="plugin-mentions-user plugin-mentions-a" href="https://forum.pycom.io/uid/98">@robert-hh</a><br />
you have right but without doc you do not know what are that numbers in touple<br />
you can guess but not for sure</p>
<p dir="auto">but as <a class="plugin-mentions-user plugin-mentions-a" href="https://forum.pycom.io/uid/32">@sakis</a> say it will change in this week</p>
]]></description><link>https://forum.pycom.io/post/2813</link><guid isPermaLink="true">https://forum.pycom.io/post/2813</guid><dc:creator><![CDATA[livius]]></dc:creator><pubDate>Mon, 09 Jan 2017 09:25:51 GMT</pubDate></item><item><title><![CDATA[Reply to Mising documentation for uos.stat() on Mon, 30 Oct 2017 13:51:23 GMT]]></title><description><![CDATA[<p dir="auto">Couldn't agree more.</p>
]]></description><link>https://forum.pycom.io/post/12214</link><guid isPermaLink="true">https://forum.pycom.io/post/12214</guid><dc:creator><![CDATA[soren]]></dc:creator><pubDate>Mon, 30 Oct 2017 13:51:23 GMT</pubDate></item><item><title><![CDATA[Reply to Mising documentation for uos.stat() on Mon, 30 Oct 2017 14:10:12 GMT]]></title><description><![CDATA[<p dir="auto"><a class="plugin-mentions-user plugin-mentions-a" href="https://forum.pycom.io/uid/1042">@soren</a> <a class="plugin-mentions-user plugin-mentions-a" href="https://forum.pycom.io/uid/110">@bmarkus</a> I see this as a semi-commercial product.<br />
The documentation is not complete and sometimes wrong, since it was taken from the <a href="http://micropython.org" target="_blank" rel="noopener noreferrer nofollow">micropython.org</a> port. Then some extension were made, but no-one seemed to have checked, whether everything fits. There seem to be a person now in <a href="http://Pycom.io" target="_blank" rel="noopener noreferrer nofollow">Pycom.io</a> dedicated to documentation, but maybe I'm wrong.<br />
But if you like, you can contribute to the documentation. Sometimes, PRs to the documentation are noticed. In case of uos.stat(), the documentation is present.</p>
]]></description><link>https://forum.pycom.io/post/12219</link><guid isPermaLink="true">https://forum.pycom.io/post/12219</guid><dc:creator><![CDATA[robert-hh]]></dc:creator><pubDate>Mon, 30 Oct 2017 14:10:12 GMT</pubDate></item><item><title><![CDATA[Reply to Mising documentation for uos.stat() on Mon, 30 Oct 2017 15:48:00 GMT]]></title><description><![CDATA[<p dir="auto"><a class="plugin-mentions-user plugin-mentions-a" href="https://forum.pycom.io/uid/98">@robert-hh</a> said in <a href="/post/12219">Mising documentation for uos.stat()</a>:</p>
<blockquote>
<p dir="auto"><a class="plugin-mentions-user plugin-mentions-a" href="https://forum.pycom.io/uid/1042">@soren</a> <a class="plugin-mentions-user plugin-mentions-a" href="https://forum.pycom.io/uid/110">@bmarkus</a> I see this as a semi-commercial product.</p>
</blockquote>
<p dir="auto">It is a commercial product range offered in form of development and OEM moduls.</p>
]]></description><link>https://forum.pycom.io/post/12229</link><guid isPermaLink="true">https://forum.pycom.io/post/12229</guid><dc:creator><![CDATA[bmarkus]]></dc:creator><pubDate>Mon, 30 Oct 2017 15:48:00 GMT</pubDate></item></channel></rss>