Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
보기 1
좋아요 0
위키 捐赠
gooderp18绿色标准版
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
브렌치: master
브랜치 태그
${ item.name }
Create branch ${ searchTerm }
from 'master'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/uuid.html

755 lines
54KB
Raw 고유링크 Blame 히스토리 

  1. <!DOCTYPE html>

  2. 

  3. <html lang="en" data-content_root="../">

  4.   <head>

  5.     <meta charset="utf-8" />

  6.     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  7. <meta property="og:title" content="uuid — UUID objects according to RFC 4122" />

  8. <meta property="og:type" content="website" />

  9. <meta property="og:url" content="https://docs.python.org/3/library/uuid.html" />

  10. <meta property="og:site_name" content="Python documentation" />

  11. <meta property="og:description" content="Source code: Lib/uuid.py This module provides immutable UUID objects (the UUID class) and the functions uuid1(), uuid3(), uuid4(), uuid5() for generating version 1, 3, 4, and 5 UUIDs as specified i..." />

  12. <meta property="og:image" content="https://docs.python.org/3/_static/og-image.png" />

  13. <meta property="og:image:alt" content="Python documentation" />

  14. <meta name="description" content="Source code: Lib/uuid.py This module provides immutable UUID objects (the UUID class) and the functions uuid1(), uuid3(), uuid4(), uuid5() for generating version 1, 3, 4, and 5 UUIDs as specified i..." />

  15. <meta property="og:image:width" content="200" />

  16. <meta property="og:image:height" content="200" />

  17. <meta name="theme-color" content="#3776ab" />

  18. 

  19.     <title>uuid — UUID objects according to RFC 4122 &#8212; Python 3.12.3 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">

  20.     

  21.     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />

  22.     <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=bb723527" />

  23.     <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=b20cc3f5" />

  24.     

  25.     <script src="../_static/documentation_options.js?v=2c828074"></script>

  26.     <script src="../_static/doctools.js?v=888ff710"></script>

  27.     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>

  28.     

  29.     <script src="../_static/sidebar.js"></script>

  30.     

  31.     <link rel="search" type="application/opensearchdescription+xml"

  32.           title="Search within Python 3.12.3 documentation"

  33.           href="../_static/opensearch.xml"/>

  34.     <link rel="author" title="About these documents" href="../about.html" />

  35.     <link rel="index" title="Index" href="../genindex.html" />

  36.     <link rel="search" title="Search" href="../search.html" />

  37.     <link rel="copyright" title="Copyright" href="../copyright.html" />

  38.     <link rel="next" title="socketserver — A framework for network servers" href="socketserver.html" />

  39.     <link rel="prev" title="smtplib — SMTP protocol client" href="smtplib.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/library/uuid.html" />

  41.     

  42.       

  43.     

  44. 

  45.     

  46.     <style>

  47.       @media only screen {

  48.         table.full-width-table {

  49.             width: 100%;

  50.         }

  51.       }

  52.     </style>

  53. <link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">

  54.     <link rel="shortcut icon" type="image/png" href="../_static/py.svg" />

  55.             <script type="text/javascript" src="../_static/copybutton.js"></script>

  56.             <script type="text/javascript" src="../_static/menu.js"></script>

  57.             <script type="text/javascript" src="../_static/search-focus.js"></script>

  58.             <script type="text/javascript" src="../_static/themetoggle.js"></script> 

  59. 

  60.   </head>

  61. <body>

  62. <div class="mobile-nav">

  63.     <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"

  64.            aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />

  65.     <nav class="nav-content" role="navigation">

  66.         <label for="menuToggler" class="toggler__label">

  67.             <span></span>

  68.         </label>

  69.         <span class="nav-items-wrapper">

  70.             <a href="https://www.python.org/" class="nav-logo">

  71.                 <img src="../_static/py.svg" alt="Python logo"/>

  72.             </a>

  73.             <span class="version_switcher_placeholder"></span>

  74.             <form role="search" class="search" action="../search.html" method="get">

  75.                 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">

  76.                     <path fill-rule="nonzero" fill="currentColor" d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path>

  77.                 </svg>

  78.                 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />

  79.                 <input type="submit" value="Go"/>

  80.             </form>

  81.         </span>

  82.     </nav>

  83.     <div class="menu-wrapper">

  84.         <nav class="menu" role="navigation" aria-label="main navigation">

  85.             <div class="language_switcher_placeholder"></div>

  86.             

  87. <label class="theme-selector-label">

  88.     Theme

  89.     <select class="theme-selector" oninput="activateTheme(this.value)">

  90.         <option value="auto" selected>Auto</option>

  91.         <option value="light">Light</option>

  92.         <option value="dark">Dark</option>

  93.     </select>

  94. </label>

  95.   <div>

  96.     <h3><a href="../contents.html">Table of Contents</a></h3>

  97.     <ul>

  98. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">uuid</span></code> — UUID objects according to <strong>RFC 4122</strong></a><ul>

  99. <li><a class="reference internal" href="#command-line-usage">Command-Line Usage</a></li>

  100. <li><a class="reference internal" href="#example">Example</a></li>

  101. <li><a class="reference internal" href="#command-line-example">Command-Line Example</a></li>

  102. </ul>

  103. </li>

  104. </ul>

  105. 

  106.   </div>

  107.   <div>

  108.     <h4>Previous topic</h4>

  109.     <p class="topless"><a href="smtplib.html"

  110.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">smtplib</span></code> — SMTP protocol client</a></p>

  111.   </div>

  112.   <div>

  113.     <h4>Next topic</h4>

  114.     <p class="topless"><a href="socketserver.html"

  115.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">socketserver</span></code> — A framework for network servers</a></p>

  116.   </div>

  117.   <div role="note" aria-label="source link">

  118.     <h3>This Page</h3>

  119.     <ul class="this-page-menu">

  120.       <li><a href="../bugs.html">Report a Bug</a></li>

  121.       <li>

  122.         <a href="https://github.com/python/cpython/blob/main/Doc/library/uuid.rst"

  123.             rel="nofollow">Show Source

  124.         </a>

  125.       </li>

  126.     </ul>

  127.   </div>

  128.         </nav>

  129.     </div>

  130. </div>

  131. 

  132.   

  133.     <div class="related" role="navigation" aria-label="related navigation">

  134.       <h3>Navigation</h3>

  135.       <ul>

  136.         <li class="right" style="margin-right: 10px">

  137.           <a href="../genindex.html" title="General Index"

  138.              accesskey="I">index</a></li>

  139.         <li class="right" >

  140.           <a href="../py-modindex.html" title="Python Module Index"

  141.              >modules</a> |</li>

  142.         <li class="right" >

  143.           <a href="socketserver.html" title="socketserver — A framework for network servers"

  144.              accesskey="N">next</a> |</li>

  145.         <li class="right" >

  146.           <a href="smtplib.html" title="smtplib — SMTP protocol client"

  147.              accesskey="P">previous</a> |</li>

  148. 

  149.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  150.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  151.           <li class="switchers">

  152.             <div class="language_switcher_placeholder"></div>

  153.             <div class="version_switcher_placeholder"></div>

  154.           </li>

  155.           <li>

  156.               

  157.           </li>

  158.     <li id="cpython-language-and-version">

  159.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  160.     </li>

  161. 

  162.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  163.           <li class="nav-item nav-item-2"><a href="internet.html" accesskey="U">Internet Protocols and Support</a> &#187;</li>

  164.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">uuid</span></code> — UUID objects according to <strong>RFC 4122</strong></a></li>

  165.                 <li class="right">

  166.                     

  167. 

  168.     <div class="inline-search" role="search">

  169.         <form class="inline-search" action="../search.html" method="get">

  170.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  171.           <input type="submit" value="Go" />

  172.         </form>

  173.     </div>

  174.                      |

  175.                 </li>

  176.             <li class="right">

  177. <label class="theme-selector-label">

  178.     Theme

  179.     <select class="theme-selector" oninput="activateTheme(this.value)">

  180.         <option value="auto" selected>Auto</option>

  181.         <option value="light">Light</option>

  182.         <option value="dark">Dark</option>

  183.     </select>

  184. </label> |</li>

  185.             

  186.       </ul>

  187.     </div>    

  188. 

  189.     <div class="document">

  190.       <div class="documentwrapper">

  191.         <div class="bodywrapper">

  192.           <div class="body" role="main">

  193.             

  194.   <section id="module-uuid">

  195. <span id="uuid-uuid-objects-according-to-rfc-4122"></span><h1><a class="reference internal" href="#module-uuid" title="uuid: UUID objects (universally unique identifiers) according to RFC 4122"><code class="xref py py-mod docutils literal notranslate"><span class="pre">uuid</span></code></a> — UUID objects according to <span class="target" id="index-0"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc4122.html"><strong>RFC 4122</strong></a><a class="headerlink" href="#module-uuid" title="Link to this heading">¶</a></h1>

  196. <p><strong>Source code:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/3.12/Lib/uuid.py">Lib/uuid.py</a></p>

  197. <hr class="docutils" />

  198. <p>This module provides immutable <a class="reference internal" href="#uuid.UUID" title="uuid.UUID"><code class="xref py py-class docutils literal notranslate"><span class="pre">UUID</span></code></a> objects (the <a class="reference internal" href="#uuid.UUID" title="uuid.UUID"><code class="xref py py-class docutils literal notranslate"><span class="pre">UUID</span></code></a> class)

  199. and the functions <a class="reference internal" href="#uuid.uuid1" title="uuid.uuid1"><code class="xref py py-func docutils literal notranslate"><span class="pre">uuid1()</span></code></a>, <a class="reference internal" href="#uuid.uuid3" title="uuid.uuid3"><code class="xref py py-func docutils literal notranslate"><span class="pre">uuid3()</span></code></a>, <a class="reference internal" href="#uuid.uuid4" title="uuid.uuid4"><code class="xref py py-func docutils literal notranslate"><span class="pre">uuid4()</span></code></a>, <a class="reference internal" href="#uuid.uuid5" title="uuid.uuid5"><code class="xref py py-func docutils literal notranslate"><span class="pre">uuid5()</span></code></a> for

  200. generating version 1, 3, 4, and 5 UUIDs as specified in <span class="target" id="index-1"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc4122.html"><strong>RFC 4122</strong></a>.</p>

  201. <p>If all you want is a unique ID, you should probably call <a class="reference internal" href="#uuid.uuid1" title="uuid.uuid1"><code class="xref py py-func docutils literal notranslate"><span class="pre">uuid1()</span></code></a> or

  202. <a class="reference internal" href="#uuid.uuid4" title="uuid.uuid4"><code class="xref py py-func docutils literal notranslate"><span class="pre">uuid4()</span></code></a>.  Note that <a class="reference internal" href="#uuid.uuid1" title="uuid.uuid1"><code class="xref py py-func docutils literal notranslate"><span class="pre">uuid1()</span></code></a> may compromise privacy since it creates

  203. a UUID containing the computer’s network address.  <a class="reference internal" href="#uuid.uuid4" title="uuid.uuid4"><code class="xref py py-func docutils literal notranslate"><span class="pre">uuid4()</span></code></a> creates a

  204. random UUID.</p>

  205. <p>Depending on support from the underlying platform, <a class="reference internal" href="#uuid.uuid1" title="uuid.uuid1"><code class="xref py py-func docutils literal notranslate"><span class="pre">uuid1()</span></code></a> may or may

  206. not return a “safe” UUID.  A safe UUID is one which is generated using

  207. synchronization methods that ensure no two processes can obtain the same

  208. UUID.  All instances of <a class="reference internal" href="#uuid.UUID" title="uuid.UUID"><code class="xref py py-class docutils literal notranslate"><span class="pre">UUID</span></code></a> have an <a class="reference internal" href="#uuid.UUID.is_safe" title="uuid.UUID.is_safe"><code class="xref py py-attr docutils literal notranslate"><span class="pre">is_safe</span></code></a> attribute

  209. which relays any information about the UUID’s safety, using this enumeration:</p>

  210. <dl class="py class">

  211. <dt class="sig sig-object py" id="uuid.SafeUUID">

  212. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">uuid.</span></span><span class="sig-name descname"><span class="pre">SafeUUID</span></span><a class="headerlink" href="#uuid.SafeUUID" title="Link to this definition">¶</a></dt>

  213. <dd><div class="versionadded">

  214. <p><span class="versionmodified added">New in version 3.7.</span></p>

  215. </div>

  216. <dl class="py attribute">

  217. <dt class="sig sig-object py" id="uuid.SafeUUID.safe">

  218. <span class="sig-name descname"><span class="pre">safe</span></span><a class="headerlink" href="#uuid.SafeUUID.safe" title="Link to this definition">¶</a></dt>

  219. <dd><p>The UUID was generated by the platform in a multiprocessing-safe way.</p>

  220. </dd></dl>

  221. 

  222. <dl class="py attribute">

  223. <dt class="sig sig-object py" id="uuid.SafeUUID.unsafe">

  224. <span class="sig-name descname"><span class="pre">unsafe</span></span><a class="headerlink" href="#uuid.SafeUUID.unsafe" title="Link to this definition">¶</a></dt>

  225. <dd><p>The UUID was not generated in a multiprocessing-safe way.</p>

  226. </dd></dl>

  227. 

  228. <dl class="py attribute">

  229. <dt class="sig sig-object py" id="uuid.SafeUUID.unknown">

  230. <span class="sig-name descname"><span class="pre">unknown</span></span><a class="headerlink" href="#uuid.SafeUUID.unknown" title="Link to this definition">¶</a></dt>

  231. <dd><p>The platform does not provide information on whether the UUID was

  232. generated safely or not.</p>

  233. </dd></dl>

  234. 

  235. </dd></dl>

  236. 

  237. <dl class="py class">

  238. <dt class="sig sig-object py" id="uuid.UUID">

  239. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">uuid.</span></span><span class="sig-name descname"><span class="pre">UUID</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hex</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bytes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bytes_le</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fields</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">int</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_safe</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">SafeUUID.unknown</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#uuid.UUID" title="Link to this definition">¶</a></dt>

  240. <dd><p>Create a UUID from either a string of 32 hexadecimal digits, a string of 16

  241. bytes in big-endian order as the <em>bytes</em> argument, a string of 16 bytes in

  242. little-endian order as the <em>bytes_le</em> argument, a tuple of six integers

  243. (32-bit <em>time_low</em>, 16-bit <em>time_mid</em>, 16-bit <em>time_hi_version</em>,

  244. 8-bit <em>clock_seq_hi_variant</em>, 8-bit <em>clock_seq_low</em>, 48-bit <em>node</em>) as the

  245. <em>fields</em> argument, or a single 128-bit integer as the <em>int</em> argument.

  246. When a string of hex digits is given, curly braces, hyphens,

  247. and a URN prefix are all optional.  For example, these

  248. expressions all yield the same UUID:</p>

  249. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">UUID</span><span class="p">(</span><span class="s1">&#39;{12345678-1234-5678-1234-567812345678}&#39;</span><span class="p">)</span>

  250. <span class="n">UUID</span><span class="p">(</span><span class="s1">&#39;12345678123456781234567812345678&#39;</span><span class="p">)</span>

  251. <span class="n">UUID</span><span class="p">(</span><span class="s1">&#39;urn:uuid:12345678-1234-5678-1234-567812345678&#39;</span><span class="p">)</span>

  252. <span class="n">UUID</span><span class="p">(</span><span class="nb">bytes</span><span class="o">=</span><span class="sa">b</span><span class="s1">&#39;</span><span class="se">\x12\x34\x56\x78</span><span class="s1">&#39;</span><span class="o">*</span><span class="mi">4</span><span class="p">)</span>

  253. <span class="n">UUID</span><span class="p">(</span><span class="n">bytes_le</span><span class="o">=</span><span class="sa">b</span><span class="s1">&#39;</span><span class="se">\x78\x56\x34\x12\x34\x12\x78\x56</span><span class="s1">&#39;</span> <span class="o">+</span>

  254.               <span class="sa">b</span><span class="s1">&#39;</span><span class="se">\x12\x34\x56\x78\x12\x34\x56\x78</span><span class="s1">&#39;</span><span class="p">)</span>

  255. <span class="n">UUID</span><span class="p">(</span><span class="n">fields</span><span class="o">=</span><span class="p">(</span><span class="mh">0x12345678</span><span class="p">,</span> <span class="mh">0x1234</span><span class="p">,</span> <span class="mh">0x5678</span><span class="p">,</span> <span class="mh">0x12</span><span class="p">,</span> <span class="mh">0x34</span><span class="p">,</span> <span class="mh">0x567812345678</span><span class="p">))</span>

  256. <span class="n">UUID</span><span class="p">(</span><span class="nb">int</span><span class="o">=</span><span class="mh">0x12345678123456781234567812345678</span><span class="p">)</span>

  257. </pre></div>

  258. </div>

  259. <p>Exactly one of <em>hex</em>, <em>bytes</em>, <em>bytes_le</em>, <em>fields</em>, or <em>int</em> must be given.

  260. The <em>version</em> argument is optional; if given, the resulting UUID will have its

  261. variant and version number set according to <span class="target" id="index-2"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc4122.html"><strong>RFC 4122</strong></a>, overriding bits in the

  262. given <em>hex</em>, <em>bytes</em>, <em>bytes_le</em>, <em>fields</em>, or <em>int</em>.</p>

  263. <p>Comparison of UUID objects are made by way of comparing their

  264. <a class="reference internal" href="#uuid.UUID.int" title="uuid.UUID.int"><code class="xref py py-attr docutils literal notranslate"><span class="pre">UUID.int</span></code></a> attributes.  Comparison with a non-UUID object

  265. raises a <a class="reference internal" href="exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">TypeError</span></code></a>.</p>

  266. <p><code class="docutils literal notranslate"><span class="pre">str(uuid)</span></code> returns a string in the form

  267. <code class="docutils literal notranslate"><span class="pre">12345678-1234-5678-1234-567812345678</span></code> where the 32 hexadecimal digits

  268. represent the UUID.</p>

  269. </dd></dl>

  270. 

  271. <p><a class="reference internal" href="#uuid.UUID" title="uuid.UUID"><code class="xref py py-class docutils literal notranslate"><span class="pre">UUID</span></code></a> instances have these read-only attributes:</p>

  272. <dl class="py attribute">

  273. <dt class="sig sig-object py" id="uuid.UUID.bytes">

  274. <span class="sig-prename descclassname"><span class="pre">UUID.</span></span><span class="sig-name descname"><span class="pre">bytes</span></span><a class="headerlink" href="#uuid.UUID.bytes" title="Link to this definition">¶</a></dt>

  275. <dd><p>The UUID as a 16-byte string (containing the six integer fields in big-endian

  276. byte order).</p>

  277. </dd></dl>

  278. 

  279. <dl class="py attribute">

  280. <dt class="sig sig-object py" id="uuid.UUID.bytes_le">

  281. <span class="sig-prename descclassname"><span class="pre">UUID.</span></span><span class="sig-name descname"><span class="pre">bytes_le</span></span><a class="headerlink" href="#uuid.UUID.bytes_le" title="Link to this definition">¶</a></dt>

  282. <dd><p>The UUID as a 16-byte string (with <em>time_low</em>, <em>time_mid</em>, and <em>time_hi_version</em>

  283. in little-endian byte order).</p>

  284. </dd></dl>

  285. 

  286. <dl class="py attribute">

  287. <dt class="sig sig-object py" id="uuid.UUID.fields">

  288. <span class="sig-prename descclassname"><span class="pre">UUID.</span></span><span class="sig-name descname"><span class="pre">fields</span></span><a class="headerlink" href="#uuid.UUID.fields" title="Link to this definition">¶</a></dt>

  289. <dd><p>A tuple of the six integer fields of the UUID, which are also available as six

  290. individual attributes and two derived attributes:</p>

  291. </dd></dl>

  292. 

  293. <table class="docutils align-default">

  294. <tbody>

  295. <tr class="row-odd"><td><p>Field</p></td>

  296. <td><p>Meaning</p></td>

  297. </tr>

  298. <tr class="row-even"><td><dl class="py attribute">

  299. <dt class="sig sig-object py" id="uuid.UUID.time_low">

  300. <span class="sig-prename descclassname"><span class="pre">UUID.</span></span><span class="sig-name descname"><span class="pre">time_low</span></span><a class="headerlink" href="#uuid.UUID.time_low" title="Link to this definition">¶</a></dt>

  301. <dd></dd></dl>

  302. 

  303. </td>

  304. <td><p>The first 32 bits of the UUID.</p></td>

  305. </tr>

  306. <tr class="row-odd"><td><dl class="py attribute">

  307. <dt class="sig sig-object py" id="uuid.UUID.time_mid">

  308. <span class="sig-prename descclassname"><span class="pre">UUID.</span></span><span class="sig-name descname"><span class="pre">time_mid</span></span><a class="headerlink" href="#uuid.UUID.time_mid" title="Link to this definition">¶</a></dt>

  309. <dd></dd></dl>

  310. 

  311. </td>

  312. <td><p>The next 16 bits of the UUID.</p></td>

  313. </tr>

  314. <tr class="row-even"><td><dl class="py attribute">

  315. <dt class="sig sig-object py" id="uuid.UUID.time_hi_version">

  316. <span class="sig-prename descclassname"><span class="pre">UUID.</span></span><span class="sig-name descname"><span class="pre">time_hi_version</span></span><a class="headerlink" href="#uuid.UUID.time_hi_version" title="Link to this definition">¶</a></dt>

  317. <dd></dd></dl>

  318. 

  319. </td>

  320. <td><p>The next 16 bits of the UUID.</p></td>

  321. </tr>

  322. <tr class="row-odd"><td><dl class="py attribute">

  323. <dt class="sig sig-object py" id="uuid.UUID.clock_seq_hi_variant">

  324. <span class="sig-prename descclassname"><span class="pre">UUID.</span></span><span class="sig-name descname"><span class="pre">clock_seq_hi_variant</span></span><a class="headerlink" href="#uuid.UUID.clock_seq_hi_variant" title="Link to this definition">¶</a></dt>

  325. <dd></dd></dl>

  326. 

  327. </td>

  328. <td><p>The next 8 bits of the UUID.</p></td>

  329. </tr>

  330. <tr class="row-even"><td><dl class="py attribute">

  331. <dt class="sig sig-object py" id="uuid.UUID.clock_seq_low">

  332. <span class="sig-prename descclassname"><span class="pre">UUID.</span></span><span class="sig-name descname"><span class="pre">clock_seq_low</span></span><a class="headerlink" href="#uuid.UUID.clock_seq_low" title="Link to this definition">¶</a></dt>

  333. <dd></dd></dl>

  334. 

  335. </td>

  336. <td><p>The next 8 bits of the UUID.</p></td>

  337. </tr>

  338. <tr class="row-odd"><td><dl class="py attribute">

  339. <dt class="sig sig-object py" id="uuid.UUID.node">

  340. <span class="sig-prename descclassname"><span class="pre">UUID.</span></span><span class="sig-name descname"><span class="pre">node</span></span><a class="headerlink" href="#uuid.UUID.node" title="Link to this definition">¶</a></dt>

  341. <dd></dd></dl>

  342. 

  343. </td>

  344. <td><p>The last 48 bits of the UUID.</p></td>

  345. </tr>

  346. <tr class="row-even"><td><dl class="py attribute">

  347. <dt class="sig sig-object py" id="uuid.UUID.time">

  348. <span class="sig-prename descclassname"><span class="pre">UUID.</span></span><span class="sig-name descname"><span class="pre">time</span></span><a class="headerlink" href="#uuid.UUID.time" title="Link to this definition">¶</a></dt>

  349. <dd></dd></dl>

  350. 

  351. </td>

  352. <td><p>The 60-bit timestamp.</p></td>

  353. </tr>

  354. <tr class="row-odd"><td><dl class="py attribute">

  355. <dt class="sig sig-object py" id="uuid.UUID.clock_seq">

  356. <span class="sig-prename descclassname"><span class="pre">UUID.</span></span><span class="sig-name descname"><span class="pre">clock_seq</span></span><a class="headerlink" href="#uuid.UUID.clock_seq" title="Link to this definition">¶</a></dt>

  357. <dd></dd></dl>

  358. 

  359. </td>

  360. <td><p>The 14-bit sequence number.</p></td>

  361. </tr>

  362. </tbody>

  363. </table>

  364. <dl class="py attribute">

  365. <dt class="sig sig-object py" id="uuid.UUID.hex">

  366. <span class="sig-prename descclassname"><span class="pre">UUID.</span></span><span class="sig-name descname"><span class="pre">hex</span></span><a class="headerlink" href="#uuid.UUID.hex" title="Link to this definition">¶</a></dt>

  367. <dd><p>The UUID as a 32-character lowercase hexadecimal string.</p>

  368. </dd></dl>

  369. 

  370. <dl class="py attribute">

  371. <dt class="sig sig-object py" id="uuid.UUID.int">

  372. <span class="sig-prename descclassname"><span class="pre">UUID.</span></span><span class="sig-name descname"><span class="pre">int</span></span><a class="headerlink" href="#uuid.UUID.int" title="Link to this definition">¶</a></dt>

  373. <dd><p>The UUID as a 128-bit integer.</p>

  374. </dd></dl>

  375. 

  376. <dl class="py attribute">

  377. <dt class="sig sig-object py" id="uuid.UUID.urn">

  378. <span class="sig-prename descclassname"><span class="pre">UUID.</span></span><span class="sig-name descname"><span class="pre">urn</span></span><a class="headerlink" href="#uuid.UUID.urn" title="Link to this definition">¶</a></dt>

  379. <dd><p>The UUID as a URN as specified in <span class="target" id="index-3"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc4122.html"><strong>RFC 4122</strong></a>.</p>

  380. </dd></dl>

  381. 

  382. <dl class="py attribute">

  383. <dt class="sig sig-object py" id="uuid.UUID.variant">

  384. <span class="sig-prename descclassname"><span class="pre">UUID.</span></span><span class="sig-name descname"><span class="pre">variant</span></span><a class="headerlink" href="#uuid.UUID.variant" title="Link to this definition">¶</a></dt>

  385. <dd><p>The UUID variant, which determines the internal layout of the UUID. This will be

  386. one of the constants <a class="reference internal" href="#uuid.RESERVED_NCS" title="uuid.RESERVED_NCS"><code class="xref py py-const docutils literal notranslate"><span class="pre">RESERVED_NCS</span></code></a>, <a class="reference internal" href="#uuid.RFC_4122" title="uuid.RFC_4122"><code class="xref py py-const docutils literal notranslate"><span class="pre">RFC_4122</span></code></a>,

  387. <a class="reference internal" href="#uuid.RESERVED_MICROSOFT" title="uuid.RESERVED_MICROSOFT"><code class="xref py py-const docutils literal notranslate"><span class="pre">RESERVED_MICROSOFT</span></code></a>, or <a class="reference internal" href="#uuid.RESERVED_FUTURE" title="uuid.RESERVED_FUTURE"><code class="xref py py-const docutils literal notranslate"><span class="pre">RESERVED_FUTURE</span></code></a>.</p>

  388. </dd></dl>

  389. 

  390. <dl class="py attribute">

  391. <dt class="sig sig-object py" id="uuid.UUID.version">

  392. <span class="sig-prename descclassname"><span class="pre">UUID.</span></span><span class="sig-name descname"><span class="pre">version</span></span><a class="headerlink" href="#uuid.UUID.version" title="Link to this definition">¶</a></dt>

  393. <dd><p>The UUID version number (1 through 5, meaningful only when the variant is

  394. <a class="reference internal" href="#uuid.RFC_4122" title="uuid.RFC_4122"><code class="xref py py-const docutils literal notranslate"><span class="pre">RFC_4122</span></code></a>).</p>

  395. </dd></dl>

  396. 

  397. <dl class="py attribute">

  398. <dt class="sig sig-object py" id="uuid.UUID.is_safe">

  399. <span class="sig-prename descclassname"><span class="pre">UUID.</span></span><span class="sig-name descname"><span class="pre">is_safe</span></span><a class="headerlink" href="#uuid.UUID.is_safe" title="Link to this definition">¶</a></dt>

  400. <dd><p>An enumeration of <a class="reference internal" href="#uuid.SafeUUID" title="uuid.SafeUUID"><code class="xref py py-class docutils literal notranslate"><span class="pre">SafeUUID</span></code></a> which indicates whether the platform

  401. generated the UUID in a multiprocessing-safe way.</p>

  402. <div class="versionadded">

  403. <p><span class="versionmodified added">New in version 3.7.</span></p>

  404. </div>

  405. </dd></dl>

  406. 

  407. <p>The <a class="reference internal" href="#module-uuid" title="uuid: UUID objects (universally unique identifiers) according to RFC 4122"><code class="xref py py-mod docutils literal notranslate"><span class="pre">uuid</span></code></a> module defines the following functions:</p>

  408. <dl class="py function">

  409. <dt class="sig sig-object py" id="uuid.getnode">

  410. <span class="sig-prename descclassname"><span class="pre">uuid.</span></span><span class="sig-name descname"><span class="pre">getnode</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#uuid.getnode" title="Link to this definition">¶</a></dt>

  411. <dd><p>Get the hardware address as a 48-bit positive integer.  The first time this

  412. runs, it may launch a separate program, which could be quite slow.  If all

  413. attempts to obtain the hardware address fail, we choose a random 48-bit

  414. number with the multicast bit (least significant bit of the first octet)

  415. set to 1 as recommended in <span class="target" id="index-4"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc4122.html"><strong>RFC 4122</strong></a>.  “Hardware address” means the MAC

  416. address of a network interface.  On a machine with multiple network

  417. interfaces, universally administered MAC addresses (i.e. where the second

  418. least significant bit of the first octet is <em>unset</em>) will be preferred over

  419. locally administered MAC addresses, but with no other ordering guarantees.</p>

  420. <div class="versionchanged">

  421. <p><span class="versionmodified changed">Changed in version 3.7: </span>Universally administered MAC addresses are preferred over locally

  422. administered MAC addresses, since the former are guaranteed to be

  423. globally unique, while the latter are not.</p>

  424. </div>

  425. </dd></dl>

  426. 

  427. <dl class="py function" id="index-5">

  428. <dt class="sig sig-object py" id="uuid.uuid1">

  429. <span class="sig-prename descclassname"><span class="pre">uuid.</span></span><span class="sig-name descname"><span class="pre">uuid1</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">clock_seq</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#uuid.uuid1" title="Link to this definition">¶</a></dt>

  430. <dd><p>Generate a UUID from a host ID, sequence number, and the current time. If <em>node</em>

  431. is not given, <a class="reference internal" href="#uuid.getnode" title="uuid.getnode"><code class="xref py py-func docutils literal notranslate"><span class="pre">getnode()</span></code></a> is used to obtain the hardware address. If

  432. <em>clock_seq</em> is given, it is used as the sequence number; otherwise a random

  433. 14-bit sequence number is chosen.</p>

  434. </dd></dl>

  435. 

  436. <dl class="py function" id="index-6">

  437. <dt class="sig sig-object py" id="uuid.uuid3">

  438. <span class="sig-prename descclassname"><span class="pre">uuid.</span></span><span class="sig-name descname"><span class="pre">uuid3</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#uuid.uuid3" title="Link to this definition">¶</a></dt>

  439. <dd><p>Generate a UUID based on the MD5 hash of a namespace identifier (which is a

  440. UUID) and a name (which is a <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> object or a string

  441. that will be encoded using UTF-8).</p>

  442. </dd></dl>

  443. 

  444. <dl class="py function" id="index-7">

  445. <dt class="sig sig-object py" id="uuid.uuid4">

  446. <span class="sig-prename descclassname"><span class="pre">uuid.</span></span><span class="sig-name descname"><span class="pre">uuid4</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#uuid.uuid4" title="Link to this definition">¶</a></dt>

  447. <dd><p>Generate a random UUID.</p>

  448. </dd></dl>

  449. 

  450. <dl class="py function" id="index-8">

  451. <dt class="sig sig-object py" id="uuid.uuid5">

  452. <span class="sig-prename descclassname"><span class="pre">uuid.</span></span><span class="sig-name descname"><span class="pre">uuid5</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#uuid.uuid5" title="Link to this definition">¶</a></dt>

  453. <dd><p>Generate a UUID based on the SHA-1 hash of a namespace identifier (which is a

  454. UUID) and a name (which is a <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> object or a string

  455. that will be encoded using UTF-8).</p>

  456. </dd></dl>

  457. 

  458. <p id="index-9">The <a class="reference internal" href="#module-uuid" title="uuid: UUID objects (universally unique identifiers) according to RFC 4122"><code class="xref py py-mod docutils literal notranslate"><span class="pre">uuid</span></code></a> module defines the following namespace identifiers for use with

  459. <a class="reference internal" href="#uuid.uuid3" title="uuid.uuid3"><code class="xref py py-func docutils literal notranslate"><span class="pre">uuid3()</span></code></a> or <a class="reference internal" href="#uuid.uuid5" title="uuid.uuid5"><code class="xref py py-func docutils literal notranslate"><span class="pre">uuid5()</span></code></a>.</p>

  460. <dl class="py data">

  461. <dt class="sig sig-object py" id="uuid.NAMESPACE_DNS">

  462. <span class="sig-prename descclassname"><span class="pre">uuid.</span></span><span class="sig-name descname"><span class="pre">NAMESPACE_DNS</span></span><a class="headerlink" href="#uuid.NAMESPACE_DNS" title="Link to this definition">¶</a></dt>

  463. <dd><p>When this namespace is specified, the <em>name</em> string is a fully qualified domain

  464. name.</p>

  465. </dd></dl>

  466. 

  467. <dl class="py data">

  468. <dt class="sig sig-object py" id="uuid.NAMESPACE_URL">

  469. <span class="sig-prename descclassname"><span class="pre">uuid.</span></span><span class="sig-name descname"><span class="pre">NAMESPACE_URL</span></span><a class="headerlink" href="#uuid.NAMESPACE_URL" title="Link to this definition">¶</a></dt>

  470. <dd><p>When this namespace is specified, the <em>name</em> string is a URL.</p>

  471. </dd></dl>

  472. 

  473. <dl class="py data">

  474. <dt class="sig sig-object py" id="uuid.NAMESPACE_OID">

  475. <span class="sig-prename descclassname"><span class="pre">uuid.</span></span><span class="sig-name descname"><span class="pre">NAMESPACE_OID</span></span><a class="headerlink" href="#uuid.NAMESPACE_OID" title="Link to this definition">¶</a></dt>

  476. <dd><p>When this namespace is specified, the <em>name</em> string is an ISO OID.</p>

  477. </dd></dl>

  478. 

  479. <dl class="py data">

  480. <dt class="sig sig-object py" id="uuid.NAMESPACE_X500">

  481. <span class="sig-prename descclassname"><span class="pre">uuid.</span></span><span class="sig-name descname"><span class="pre">NAMESPACE_X500</span></span><a class="headerlink" href="#uuid.NAMESPACE_X500" title="Link to this definition">¶</a></dt>

  482. <dd><p>When this namespace is specified, the <em>name</em> string is an X.500 DN in DER or a

  483. text output format.</p>

  484. </dd></dl>

  485. 

  486. <p>The <a class="reference internal" href="#module-uuid" title="uuid: UUID objects (universally unique identifiers) according to RFC 4122"><code class="xref py py-mod docutils literal notranslate"><span class="pre">uuid</span></code></a> module defines the following constants for the possible values

  487. of the <a class="reference internal" href="#uuid.UUID.variant" title="uuid.UUID.variant"><code class="xref py py-attr docutils literal notranslate"><span class="pre">variant</span></code></a> attribute:</p>

  488. <dl class="py data">

  489. <dt class="sig sig-object py" id="uuid.RESERVED_NCS">

  490. <span class="sig-prename descclassname"><span class="pre">uuid.</span></span><span class="sig-name descname"><span class="pre">RESERVED_NCS</span></span><a class="headerlink" href="#uuid.RESERVED_NCS" title="Link to this definition">¶</a></dt>

  491. <dd><p>Reserved for NCS compatibility.</p>

  492. </dd></dl>

  493. 

  494. <dl class="py data">

  495. <dt class="sig sig-object py" id="uuid.RFC_4122">

  496. <span class="sig-prename descclassname"><span class="pre">uuid.</span></span><span class="sig-name descname"><span class="pre">RFC_4122</span></span><a class="headerlink" href="#uuid.RFC_4122" title="Link to this definition">¶</a></dt>

  497. <dd><p>Specifies the UUID layout given in <span class="target" id="index-10"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc4122.html"><strong>RFC 4122</strong></a>.</p>

  498. </dd></dl>

  499. 

  500. <dl class="py data">

  501. <dt class="sig sig-object py" id="uuid.RESERVED_MICROSOFT">

  502. <span class="sig-prename descclassname"><span class="pre">uuid.</span></span><span class="sig-name descname"><span class="pre">RESERVED_MICROSOFT</span></span><a class="headerlink" href="#uuid.RESERVED_MICROSOFT" title="Link to this definition">¶</a></dt>

  503. <dd><p>Reserved for Microsoft compatibility.</p>

  504. </dd></dl>

  505. 

  506. <dl class="py data">

  507. <dt class="sig sig-object py" id="uuid.RESERVED_FUTURE">

  508. <span class="sig-prename descclassname"><span class="pre">uuid.</span></span><span class="sig-name descname"><span class="pre">RESERVED_FUTURE</span></span><a class="headerlink" href="#uuid.RESERVED_FUTURE" title="Link to this definition">¶</a></dt>

  509. <dd><p>Reserved for future definition.</p>

  510. </dd></dl>

  511. 

  512. <div class="admonition seealso">

  513. <p class="admonition-title">See also</p>

  514. <dl class="simple">

  515. <dt><span class="target" id="index-11"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc4122.html"><strong>RFC 4122</strong></a> - A Universally Unique IDentifier (UUID) URN Namespace</dt><dd><p>This specification defines a Uniform Resource Name namespace for UUIDs, the

  516. internal format of UUIDs, and methods of generating UUIDs.</p>

  517. </dd>

  518. </dl>

  519. </div>

  520. <section id="command-line-usage">

  521. <span id="uuid-cli"></span><h2>Command-Line Usage<a class="headerlink" href="#command-line-usage" title="Link to this heading">¶</a></h2>

  522. <div class="versionadded">

  523. <p><span class="versionmodified added">New in version 3.12.</span></p>

  524. </div>

  525. <p>The <a class="reference internal" href="#module-uuid" title="uuid: UUID objects (universally unique identifiers) according to RFC 4122"><code class="xref py py-mod docutils literal notranslate"><span class="pre">uuid</span></code></a> module can be executed as a script from the command line.</p>

  526. <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>-m<span class="w"> </span>uuid<span class="w"> </span><span class="o">[</span>-h<span class="o">]</span><span class="w"> </span><span class="o">[</span>-u<span class="w"> </span><span class="o">{</span>uuid1,uuid3,uuid4,uuid5<span class="o">}]</span><span class="w"> </span><span class="o">[</span>-n<span class="w"> </span>NAMESPACE<span class="o">]</span><span class="w"> </span><span class="o">[</span>-N<span class="w"> </span>NAME<span class="o">]</span>

  527. </pre></div>

  528. </div>

  529. <p>The following options are accepted:</p>

  530. <dl class="std option">

  531. <dt class="sig sig-object std" id="cmdoption-uuid-h">

  532. <span id="cmdoption-uuid-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-uuid-h" title="Link to this definition">¶</a></dt>

  533. <dd><p>Show the help message and exit.</p>

  534. </dd></dl>

  535. 

  536. <dl class="std option">

  537. <dt class="sig sig-object std" id="cmdoption-uuid-u">

  538. <span class="sig-name descname"><span class="pre">-u</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;uuid&gt;</span></span><a class="headerlink" href="#cmdoption-uuid-u" title="Link to this definition">¶</a></dt>

  539. <dt class="sig sig-object std" id="cmdoption-uuid-uuid">

  540. <span class="sig-name descname"><span class="pre">--uuid</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;uuid&gt;</span></span><a class="headerlink" href="#cmdoption-uuid-uuid" title="Link to this definition">¶</a></dt>

  541. <dd><p>Specify the function name to use to generate the uuid. By default <a class="reference internal" href="#uuid.uuid4" title="uuid.uuid4"><code class="xref py py-func docutils literal notranslate"><span class="pre">uuid4()</span></code></a>

  542. is used.</p>

  543. </dd></dl>

  544. 

  545. <dl class="std option">

  546. <dt class="sig sig-object std" id="cmdoption-uuid-n">

  547. <span class="sig-name descname"><span class="pre">-n</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;namespace&gt;</span></span><a class="headerlink" href="#cmdoption-uuid-n" title="Link to this definition">¶</a></dt>

  548. <dt class="sig sig-object std" id="cmdoption-uuid-namespace">

  549. <span class="sig-name descname"><span class="pre">--namespace</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;namespace&gt;</span></span><a class="headerlink" href="#cmdoption-uuid-namespace" title="Link to this definition">¶</a></dt>

  550. <dd><p>The namespace is a <code class="docutils literal notranslate"><span class="pre">UUID</span></code>, or <code class="docutils literal notranslate"><span class="pre">&#64;ns</span></code> where <code class="docutils literal notranslate"><span class="pre">ns</span></code> is a well-known predefined UUID

  551. addressed by namespace name. Such as <code class="docutils literal notranslate"><span class="pre">&#64;dns</span></code>, <code class="docutils literal notranslate"><span class="pre">&#64;url</span></code>, <code class="docutils literal notranslate"><span class="pre">&#64;oid</span></code>, and <code class="docutils literal notranslate"><span class="pre">&#64;x500</span></code>.

  552. Only required for <a class="reference internal" href="#uuid.uuid3" title="uuid.uuid3"><code class="xref py py-func docutils literal notranslate"><span class="pre">uuid3()</span></code></a> / <a class="reference internal" href="#uuid.uuid5" title="uuid.uuid5"><code class="xref py py-func docutils literal notranslate"><span class="pre">uuid5()</span></code></a> functions.</p>

  553. </dd></dl>

  554. 

  555. <dl class="std option">

  556. <dt class="sig sig-object std" id="cmdoption-uuid-N">

  557. <span class="sig-name descname"><span class="pre">-N</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;name&gt;</span></span><a class="headerlink" href="#cmdoption-uuid-N" title="Link to this definition">¶</a></dt>

  558. <dt class="sig sig-object std" id="cmdoption-uuid-name">

  559. <span class="sig-name descname"><span class="pre">--name</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;name&gt;</span></span><a class="headerlink" href="#cmdoption-uuid-name" title="Link to this definition">¶</a></dt>

  560. <dd><p>The name used as part of generating the uuid. Only required for

  561. <a class="reference internal" href="#uuid.uuid3" title="uuid.uuid3"><code class="xref py py-func docutils literal notranslate"><span class="pre">uuid3()</span></code></a> / <a class="reference internal" href="#uuid.uuid5" title="uuid.uuid5"><code class="xref py py-func docutils literal notranslate"><span class="pre">uuid5()</span></code></a> functions.</p>

  562. </dd></dl>

  563. 

  564. </section>

  565. <section id="example">

  566. <span id="uuid-example"></span><h2>Example<a class="headerlink" href="#example" title="Link to this heading">¶</a></h2>

  567. <p>Here are some examples of typical usage of the <a class="reference internal" href="#module-uuid" title="uuid: UUID objects (universally unique identifiers) according to RFC 4122"><code class="xref py py-mod docutils literal notranslate"><span class="pre">uuid</span></code></a> module:</p>

  568. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">uuid</span>

  569. 

  570. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># make a UUID based on the host ID and current time</span>

  571. <span class="gp">&gt;&gt;&gt; </span><span class="n">uuid</span><span class="o">.</span><span class="n">uuid1</span><span class="p">()</span>

  572. <span class="go">UUID(&#39;a8098c1a-f86e-11da-bd1a-00112444be1e&#39;)</span>

  573. 

  574. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># make a UUID using an MD5 hash of a namespace UUID and a name</span>

  575. <span class="gp">&gt;&gt;&gt; </span><span class="n">uuid</span><span class="o">.</span><span class="n">uuid3</span><span class="p">(</span><span class="n">uuid</span><span class="o">.</span><span class="n">NAMESPACE_DNS</span><span class="p">,</span> <span class="s1">&#39;python.org&#39;</span><span class="p">)</span>

  576. <span class="go">UUID(&#39;6fa459ea-ee8a-3ca4-894e-db77e160355e&#39;)</span>

  577. 

  578. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># make a random UUID</span>

  579. <span class="gp">&gt;&gt;&gt; </span><span class="n">uuid</span><span class="o">.</span><span class="n">uuid4</span><span class="p">()</span>

  580. <span class="go">UUID(&#39;16fd2706-8baf-433b-82eb-8c7fada847da&#39;)</span>

  581. 

  582. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># make a UUID using a SHA-1 hash of a namespace UUID and a name</span>

  583. <span class="gp">&gt;&gt;&gt; </span><span class="n">uuid</span><span class="o">.</span><span class="n">uuid5</span><span class="p">(</span><span class="n">uuid</span><span class="o">.</span><span class="n">NAMESPACE_DNS</span><span class="p">,</span> <span class="s1">&#39;python.org&#39;</span><span class="p">)</span>

  584. <span class="go">UUID(&#39;886313e1-3b8a-5372-9b90-0c9aee199e5d&#39;)</span>

  585. 

  586. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># make a UUID from a string of hex digits (braces and hyphens ignored)</span>

  587. <span class="gp">&gt;&gt;&gt; </span><span class="n">x</span> <span class="o">=</span> <span class="n">uuid</span><span class="o">.</span><span class="n">UUID</span><span class="p">(</span><span class="s1">&#39;{00010203-0405-0607-0809-0a0b0c0d0e0f}&#39;</span><span class="p">)</span>

  588. 

  589. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># convert a UUID to a string of hex digits in standard form</span>

  590. <span class="gp">&gt;&gt;&gt; </span><span class="nb">str</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>

  591. <span class="go">&#39;00010203-0405-0607-0809-0a0b0c0d0e0f&#39;</span>

  592. 

  593. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># get the raw 16 bytes of the UUID</span>

  594. <span class="gp">&gt;&gt;&gt; </span><span class="n">x</span><span class="o">.</span><span class="n">bytes</span>

  595. <span class="go">b&#39;\x00\x01\x02\x03\x04\x05\x06\x07\x08\t\n\x0b\x0c\r\x0e\x0f&#39;</span>

  596. 

  597. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># make a UUID from a 16-byte string</span>

  598. <span class="gp">&gt;&gt;&gt; </span><span class="n">uuid</span><span class="o">.</span><span class="n">UUID</span><span class="p">(</span><span class="nb">bytes</span><span class="o">=</span><span class="n">x</span><span class="o">.</span><span class="n">bytes</span><span class="p">)</span>

  599. <span class="go">UUID(&#39;00010203-0405-0607-0809-0a0b0c0d0e0f&#39;)</span>

  600. </pre></div>

  601. </div>

  602. </section>

  603. <section id="command-line-example">

  604. <span id="uuid-cli-example"></span><h2>Command-Line Example<a class="headerlink" href="#command-line-example" title="Link to this heading">¶</a></h2>

  605. <p>Here are some examples of typical usage of the <a class="reference internal" href="#module-uuid" title="uuid: UUID objects (universally unique identifiers) according to RFC 4122"><code class="xref py py-mod docutils literal notranslate"><span class="pre">uuid</span></code></a> command line interface:</p>

  606. <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="c1"># generate a random uuid - by default uuid4() is used</span>

  607. $<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>uuid

  608. 

  609. <span class="c1"># generate a uuid using uuid1()</span>

  610. $<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>uuid<span class="w"> </span>-u<span class="w"> </span>uuid1

  611. 

  612. <span class="c1"># generate a uuid using uuid5</span>

  613. $<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>uuid<span class="w"> </span>-u<span class="w"> </span>uuid5<span class="w"> </span>-n<span class="w"> </span>@url<span class="w"> </span>-N<span class="w"> </span>example.com

  614. </pre></div>

  615. </div>

  616. </section>

  617. </section>

  618. 

  619. 

  620.             <div class="clearer"></div>

  621.           </div>

  622.         </div>

  623.       </div>

  624.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">

  625.         <div class="sphinxsidebarwrapper">

  626.   <div>

  627.     <h3><a href="../contents.html">Table of Contents</a></h3>

  628.     <ul>

  629. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">uuid</span></code> — UUID objects according to <strong>RFC 4122</strong></a><ul>

  630. <li><a class="reference internal" href="#command-line-usage">Command-Line Usage</a></li>

  631. <li><a class="reference internal" href="#example">Example</a></li>

  632. <li><a class="reference internal" href="#command-line-example">Command-Line Example</a></li>

  633. </ul>

  634. </li>

  635. </ul>

  636. 

  637.   </div>

  638.   <div>

  639.     <h4>Previous topic</h4>

  640.     <p class="topless"><a href="smtplib.html"

  641.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">smtplib</span></code> — SMTP protocol client</a></p>

  642.   </div>

  643.   <div>

  644.     <h4>Next topic</h4>

  645.     <p class="topless"><a href="socketserver.html"

  646.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">socketserver</span></code> — A framework for network servers</a></p>

  647.   </div>

  648.   <div role="note" aria-label="source link">

  649.     <h3>This Page</h3>

  650.     <ul class="this-page-menu">

  651.       <li><a href="../bugs.html">Report a Bug</a></li>

  652.       <li>

  653.         <a href="https://github.com/python/cpython/blob/main/Doc/library/uuid.rst"

  654.             rel="nofollow">Show Source

  655.         </a>

  656.       </li>

  657.     </ul>

  658.   </div>

  659.         </div>

  660. <div id="sidebarbutton" title="Collapse sidebar">

  661. <span>«</span>

  662. </div>

  663. 

  664.       </div>

  665.       <div class="clearer"></div>

  666.     </div>  

  667.     <div class="related" role="navigation" aria-label="related navigation">

  668.       <h3>Navigation</h3>

  669.       <ul>

  670.         <li class="right" style="margin-right: 10px">

  671.           <a href="../genindex.html" title="General Index"

  672.              >index</a></li>

  673.         <li class="right" >

  674.           <a href="../py-modindex.html" title="Python Module Index"

  675.              >modules</a> |</li>

  676.         <li class="right" >

  677.           <a href="socketserver.html" title="socketserver — A framework for network servers"

  678.              >next</a> |</li>

  679.         <li class="right" >

  680.           <a href="smtplib.html" title="smtplib — SMTP protocol client"

  681.              >previous</a> |</li>

  682. 

  683.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  684.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  685.           <li class="switchers">

  686.             <div class="language_switcher_placeholder"></div>

  687.             <div class="version_switcher_placeholder"></div>

  688.           </li>

  689.           <li>

  690.               

  691.           </li>

  692.     <li id="cpython-language-and-version">

  693.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  694.     </li>

  695. 

  696.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  697.           <li class="nav-item nav-item-2"><a href="internet.html" >Internet Protocols and Support</a> &#187;</li>

  698.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">uuid</span></code> — UUID objects according to <strong>RFC 4122</strong></a></li>

  699.                 <li class="right">

  700.                     

  701. 

  702.     <div class="inline-search" role="search">

  703.         <form class="inline-search" action="../search.html" method="get">

  704.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  705.           <input type="submit" value="Go" />

  706.         </form>

  707.     </div>

  708.                      |

  709.                 </li>

  710.             <li class="right">

  711. <label class="theme-selector-label">

  712.     Theme

  713.     <select class="theme-selector" oninput="activateTheme(this.value)">

  714.         <option value="auto" selected>Auto</option>

  715.         <option value="light">Light</option>

  716.         <option value="dark">Dark</option>

  717.     </select>

  718. </label> |</li>

  719.             

  720.       </ul>

  721.     </div>  

  722.     <div class="footer">

  723.     &copy; 

  724.       <a href="../copyright.html">

  725.     

  726.     Copyright

  727.     

  728.       </a>

  729.      2001-2024, Python Software Foundation.

  730.     <br />

  731.     This page is licensed under the Python Software Foundation License Version 2.

  732.     <br />

  733.     Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.

  734.     <br />

  735.     

  736.       See <a href="/license.html">History and License</a> for more information.<br />

  737.     

  738.     

  739.     <br />

  740. 

  741.     The Python Software Foundation is a non-profit corporation.

  742. <a href="https://www.python.org/psf/donations/">Please donate.</a>

  743. <br />

  744.     <br />

  745.       Last updated on Apr 09, 2024 (13:47 UTC).

  746.     

  747.       <a href="/bugs.html">Found a bug</a>?

  748.     

  749.     <br />

  750. 

  751.     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

  752.     </div>

  753. 

  754.   </body>

  755. </html>
上海开阖软件有限公司 沪ICP备12045867号-1