Merge pull request #336 from JDJGInc/master

Implement discord.utils.generate_snowflake

Author: Lulalaby

discord/object.py

@@ -91,3 +91,18 @@ def __repr__(self) -> str:
     def created_at(self) -> datetime.datetime:
         """:class:`datetime.datetime`: Returns the snowflake's creation time in UTC."""
         return utils.snowflake_time(self.id)
+    
+    @property
+    def worker_id(self) -> int:
+        """:class:`int`: Returns the worker id that made the snowflake."""
+        return (self.id & 0x3E0000) >> 17
+
+    @property
+    def process_id(self) -> int:
+        """:class:`int`: Returns the process id that made the snowflake."""
+        return (self.id & 0x1F000) >> 12
+
+    @property
+    def increment_id(self) -> int:
+        """:class:`int`: Returns the increment id that made the snowflake."""
+        return (self.id & 0xFFF)

discord/utils.py

@@ -74,18 +74,19 @@
 
 
 __all__ = (
-    'oauth_url',
-    'snowflake_time',
-    'time_snowflake',
-    'find',
-    'get',
-    'sleep_until',
-    'utcnow',
-    'remove_markdown',
-    'escape_markdown',
-    'escape_mentions',
-    'as_chunks',
-    'format_dt',
+    "oauth_url",
+    "snowflake_time",
+    "time_snowflake",
+    "find",
+    "get",
+    "sleep_until",
+    "utcnow",
+    "remove_markdown",
+    "escape_markdown",
+    "escape_mentions",
+    "as_chunks",
+    "format_dt",
+    "generate_snowflake",
 )
 
 DISCORD_EPOCH = 1420070400000
@@ -1034,6 +1035,26 @@ def format_dt(dt: datetime.datetime, /, style: Optional[TimestampStyle] = None)
     return f'<t:{int(dt.timestamp())}:{style}>'
 
 
+def generate_snowflake(dt: Optional[datetime.datetime] = None) -> int:
+    """Returns a numeric snowflake pretending to be created at the given date but more accurate and random than time_snowflake.
+    If No dt is not passed, it makes one from the current time using utcnow.
+
+    Parameters
+    -----------
+    dt: :class:`datetime.datetime`
+        A datetime object to convert to a snowflake.
+        If naive, the timezone is assumed to be local time.
+
+    Returns
+    --------
+    :class:`int`
+        The snowflake representing the time given.
+    """
+
+    dt = dt or utcnow()
+    return int(dt.timestamp() * 1000 - DISCORD_EPOCH) << 22 | 0x3fffff
+
+
 def basic_autocomplete(values: Union[Iterable[str],
                                      Callable[[Interaction], Union[Iterable[str], Coroutine[Iterable[str]]]],
                                      Coroutine[Iterable[str]]]) -> Callable[[Interaction, str], Coroutine[List[str]]]:
@@ -1081,4 +1102,4 @@ async def autocomplete_callback(interaction: Interaction,
             _values = await _values
         return ([x for x in _values if x.lower().startswith(value.lower())])[:25]
 
-    return autocomplete_callback
+    return autocomplete_callback

docs/api.rst

@@ -1192,6 +1192,10 @@ Utility Functions
 
 .. autofunction:: discord.utils.as_chunks
 
+.. autofunction:: discord.utils.time_snowflake
+
+.. autofunction:: discord.utils.generate_snowflake
+
 .. _discord-api-enums:
 
 Enumerations