├── README.md ├── .gitignore ├── snowflake.py └── LICENSE /README.md: -------------------------------------------------------------------------------- 1 | A Python generator for the [Twitter 2 | Snowflake](https://github.com/twitter/snowflake) scheme in 61 lines of spacious 3 | code. 4 | 5 | ```python 6 | 7 | >>> import snowflake 8 | >>> s = snowflake.generator(1, 1) 9 | >>> s.next() 10 | 1132805160360349696 11 | >>> s.next() 12 | 1132805164143611904 13 | >>> s.next() 14 | 1132805168782512128 15 | 16 | # convenience to convert a snowflake to a unix timestamp 17 | >>> snowflake.snowflake_to_timestamp(1132805168782512128) 18 | 1413056012 19 | ``` 20 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # python 2 | *.pyc 3 | *.pyo 4 | _trial_temp 5 | __pycache__ 6 | 7 | # osx 8 | *.DS_Store* 9 | 10 | # vim 11 | .*.swp 12 | 13 | # sphinx build folder 14 | _build 15 | 16 | *.py[co] 17 | 18 | # Packages 19 | *.egg 20 | *.egg-info 21 | dist 22 | build 23 | eggs 24 | parts 25 | bin 26 | include 27 | lib 28 | local 29 | share 30 | var 31 | sdist 32 | develop-eggs 33 | .installed.cfg 34 | 35 | # Installer logs 36 | pip-log.txt 37 | 38 | # Unit test / coverage reports 39 | .coverage 40 | .tox 41 | 42 | # Translations 43 | *.mo 44 | 45 | # Ropemacs 46 | .ropeproject 47 | -------------------------------------------------------------------------------- /snowflake.py: -------------------------------------------------------------------------------- 1 | import time 2 | import logging 3 | 4 | 5 | log = logging.getLogger(__name__) 6 | 7 | 8 | # Tue, 21 Mar 2006 20:50:14.000 GMT 9 | twepoch = 1142974214000L 10 | 11 | worker_id_bits = 5L 12 | data_center_id_bits = 5L 13 | max_worker_id = -1L ^ (-1L << worker_id_bits) 14 | max_data_center_id = -1L ^ (-1L << data_center_id_bits) 15 | sequence_bits = 12L 16 | worker_id_shift = sequence_bits 17 | data_center_id_shift = sequence_bits + worker_id_bits 18 | timestamp_left_shift = sequence_bits + worker_id_bits + data_center_id_bits 19 | sequence_mask = -1L ^ (-1L << sequence_bits) 20 | 21 | 22 | def snowflake_to_timestamp(_id): 23 | _id = _id >> 22 # strip the lower 22 bits 24 | _id += twepoch # adjust for twitter epoch 25 | _id = _id / 1000 # convert from milliseconds to seconds 26 | return _id 27 | 28 | 29 | def generator(worker_id, data_center_id, sleep=lambda x: time.sleep(x/1000.0)): 30 | assert worker_id >= 0 and worker_id <= max_worker_id 31 | assert data_center_id >= 0 and data_center_id <= max_data_center_id 32 | 33 | last_timestamp = -1 34 | sequence = 0 35 | 36 | while True: 37 | timestamp = long(time.time()*1000) 38 | 39 | if last_timestamp > timestamp: 40 | log.warning( 41 | "clock is moving backwards. waiting until %i" % last_timestamp) 42 | sleep(last_timestamp-timestamp) 43 | continue 44 | 45 | if last_timestamp == timestamp: 46 | sequence = (sequence + 1) & sequence_mask 47 | if sequence == 0: 48 | log.warning("sequence overrun") 49 | sequence = -1 & sequence_mask 50 | sleep(1) 51 | continue 52 | else: 53 | sequence = 0 54 | 55 | last_timestamp = timestamp 56 | 57 | yield ( 58 | ((timestamp-twepoch) << timestamp_left_shift) | 59 | (data_center_id << data_center_id_shift) | 60 | (worker_id << worker_id_shift) | 61 | sequence) 62 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Creative Commons Legal Code 2 | 3 | CC0 1.0 Universal 4 | 5 | CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE 6 | LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN 7 | ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS 8 | INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES 9 | REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS 10 | PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM 11 | THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED 12 | HEREUNDER. 13 | 14 | Statement of Purpose 15 | 16 | The laws of most jurisdictions throughout the world automatically confer 17 | exclusive Copyright and Related Rights (defined below) upon the creator 18 | and subsequent owner(s) (each and all, an "owner") of an original work of 19 | authorship and/or a database (each, a "Work"). 20 | 21 | Certain owners wish to permanently relinquish those rights to a Work for 22 | the purpose of contributing to a commons of creative, cultural and 23 | scientific works ("Commons") that the public can reliably and without fear 24 | of later claims of infringement build upon, modify, incorporate in other 25 | works, reuse and redistribute as freely as possible in any form whatsoever 26 | and for any purposes, including without limitation commercial purposes. 27 | These owners may contribute to the Commons to promote the ideal of a free 28 | culture and the further production of creative, cultural and scientific 29 | works, or to gain reputation or greater distribution for their Work in 30 | part through the use and efforts of others. 31 | 32 | For these and/or other purposes and motivations, and without any 33 | expectation of additional consideration or compensation, the person 34 | associating CC0 with a Work (the "Affirmer"), to the extent that he or she 35 | is an owner of Copyright and Related Rights in the Work, voluntarily 36 | elects to apply CC0 to the Work and publicly distribute the Work under its 37 | terms, with knowledge of his or her Copyright and Related Rights in the 38 | Work and the meaning and intended legal effect of CC0 on those rights. 39 | 40 | 1. Copyright and Related Rights. A Work made available under CC0 may be 41 | protected by copyright and related or neighboring rights ("Copyright and 42 | Related Rights"). Copyright and Related Rights include, but are not 43 | limited to, the following: 44 | 45 | i. the right to reproduce, adapt, distribute, perform, display, 46 | communicate, and translate a Work; 47 | ii. moral rights retained by the original author(s) and/or performer(s); 48 | iii. publicity and privacy rights pertaining to a person's image or 49 | likeness depicted in a Work; 50 | iv. rights protecting against unfair competition in regards to a Work, 51 | subject to the limitations in paragraph 4(a), below; 52 | v. rights protecting the extraction, dissemination, use and reuse of data 53 | in a Work; 54 | vi. database rights (such as those arising under Directive 96/9/EC of the 55 | European Parliament and of the Council of 11 March 1996 on the legal 56 | protection of databases, and under any national implementation 57 | thereof, including any amended or successor version of such 58 | directive); and 59 | vii. other similar, equivalent or corresponding rights throughout the 60 | world based on applicable law or treaty, and any national 61 | implementations thereof. 62 | 63 | 2. Waiver. To the greatest extent permitted by, but not in contravention 64 | of, applicable law, Affirmer hereby overtly, fully, permanently, 65 | irrevocably and unconditionally waives, abandons, and surrenders all of 66 | Affirmer's Copyright and Related Rights and associated claims and causes 67 | of action, whether now known or unknown (including existing as well as 68 | future claims and causes of action), in the Work (i) in all territories 69 | worldwide, (ii) for the maximum duration provided by applicable law or 70 | treaty (including future time extensions), (iii) in any current or future 71 | medium and for any number of copies, and (iv) for any purpose whatsoever, 72 | including without limitation commercial, advertising or promotional 73 | purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each 74 | member of the public at large and to the detriment of Affirmer's heirs and 75 | successors, fully intending that such Waiver shall not be subject to 76 | revocation, rescission, cancellation, termination, or any other legal or 77 | equitable action to disrupt the quiet enjoyment of the Work by the public 78 | as contemplated by Affirmer's express Statement of Purpose. 79 | 80 | 3. Public License Fallback. Should any part of the Waiver for any reason 81 | be judged legally invalid or ineffective under applicable law, then the 82 | Waiver shall be preserved to the maximum extent permitted taking into 83 | account Affirmer's express Statement of Purpose. In addition, to the 84 | extent the Waiver is so judged Affirmer hereby grants to each affected 85 | person a royalty-free, non transferable, non sublicensable, non exclusive, 86 | irrevocable and unconditional license to exercise Affirmer's Copyright and 87 | Related Rights in the Work (i) in all territories worldwide, (ii) for the 88 | maximum duration provided by applicable law or treaty (including future 89 | time extensions), (iii) in any current or future medium and for any number 90 | of copies, and (iv) for any purpose whatsoever, including without 91 | limitation commercial, advertising or promotional purposes (the 92 | "License"). The License shall be deemed effective as of the date CC0 was 93 | applied by Affirmer to the Work. Should any part of the License for any 94 | reason be judged legally invalid or ineffective under applicable law, such 95 | partial invalidity or ineffectiveness shall not invalidate the remainder 96 | of the License, and in such case Affirmer hereby affirms that he or she 97 | will not (i) exercise any of his or her remaining Copyright and Related 98 | Rights in the Work or (ii) assert any associated claims and causes of 99 | action with respect to the Work, in either case contrary to Affirmer's 100 | express Statement of Purpose. 101 | 102 | 4. Limitations and Disclaimers. 103 | 104 | a. No trademark or patent rights held by Affirmer are waived, abandoned, 105 | surrendered, licensed or otherwise affected by this document. 106 | b. Affirmer offers the Work as-is and makes no representations or 107 | warranties of any kind concerning the Work, express, implied, 108 | statutory or otherwise, including without limitation warranties of 109 | title, merchantability, fitness for a particular purpose, non 110 | infringement, or the absence of latent or other defects, accuracy, or 111 | the present or absence of errors, whether or not discoverable, all to 112 | the greatest extent permissible under applicable law. 113 | c. Affirmer disclaims responsibility for clearing rights of other persons 114 | that may apply to the Work or any use thereof, including without 115 | limitation any person's Copyright and Related Rights in the Work. 116 | Further, Affirmer disclaims responsibility for obtaining any necessary 117 | consents, permissions or other rights required for any use of the 118 | Work. 119 | d. Affirmer understands and acknowledges that Creative Commons is not a 120 | party to this document and has no duty or obligation with respect to 121 | this CC0 or use of the Work. 122 | --------------------------------------------------------------------------------