spluspy 1.0.0__tar.gz

spluspy-1.0.0/PKG-INFO

@@ -0,0 +1,86 @@
+Metadata-Version: 2.4
+Name: spluspy
+Version: 1.0.0
+Summary: Soroush Plus library for Python
+Home-page: https://github.com/Itskillmaster/spluspy
+Download-URL: https://github.com/Itskillmaster/spluspy/releases
+Author: AliMirshekari And Soroush Fathi
+Author-email: dramff1@gmail.com
+License: GPL-3.0
+Keywords: telegram api chat client library messaging mtproto
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Communications :: Chat
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Requires-Python: >=3.5
+Requires-Dist: pyaes
+Requires-Dist: rsa
+Requires-Dist: websockets
+Provides-Extra: cryptg
+Requires-Dist: cryptg; extra == "cryptg"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: download-url
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+SPlusPy
+=========
+
+**SPlusPy** is an asyncio Python 3 MTProto library to interact with
+`Soroush Plus <https://web.splus.ir>`_'s API as a user or through a
+bot account (bot API alternative).
+
+SPlusthon is a fork of Telethon adapted to work with the Soroush Plus
+messenger. It uses Soroush-specific TL schema (layer 182), DC routing,
+RSA keys, and WebSocket transport.
+
+.. note::
+
+    As with any third-party library for Soroush Plus, be careful not to
+    break Soroush Plus's Terms of Service or risk an account ban.
+
+What is this?
+-------------
+
+Soroush Plus is a popular messaging application. This library is meant
+to make it easy for you to write Python programs that can interact
+with Soroush Plus. Think of it as a wrapper that has already done the
+heavy job for you, so you can focus on developing an application.
+
+
+Installing
+----------
+
+.. code-block:: sh
+
+  pip3 install splusthon
+
+
+Creating a client
+-----------------
+
+SPlusthon includes default API credentials for Soroush Plus, so you
+can create a client without obtaining your own keys:
+
+.. code-block:: python
+
+    from splusthon import SoroushClient, events, sync
+    from splusthon.sessions import StringSession
+
+    # No api_id or api_hash needed - defaults are included
+    client = SoroushClient(StringSession())
+    client.start()
+

spluspy-1.0.0/README.rst

@@ -0,0 +1,48 @@
+SPlusPy
+=========
+
+**SPlusPy** is an asyncio Python 3 MTProto library to interact with
+`Soroush Plus <https://web.splus.ir>`_'s API as a user or through a
+bot account (bot API alternative).
+
+SPlusthon is a fork of Telethon adapted to work with the Soroush Plus
+messenger. It uses Soroush-specific TL schema (layer 182), DC routing,
+RSA keys, and WebSocket transport.
+
+.. note::
+
+    As with any third-party library for Soroush Plus, be careful not to
+    break Soroush Plus's Terms of Service or risk an account ban.
+
+What is this?
+-------------
+
+Soroush Plus is a popular messaging application. This library is meant
+to make it easy for you to write Python programs that can interact
+with Soroush Plus. Think of it as a wrapper that has already done the
+heavy job for you, so you can focus on developing an application.
+
+
+Installing
+----------
+
+.. code-block:: sh
+
+  pip3 install splusthon
+
+
+Creating a client
+-----------------
+
+SPlusthon includes default API credentials for Soroush Plus, so you
+can create a client without obtaining your own keys:
+
+.. code-block:: python
+
+    from splusthon import SoroushClient, events, sync
+    from splusthon.sessions import StringSession
+
+    # No api_id or api_hash needed - defaults are included
+    client = SoroushClient(StringSession())
+    client.start()
+

spluspy-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

spluspy-1.0.0/setup.py

@@ -0,0 +1,264 @@
+#!/usr/bin/env python3
+"""A setuptools based setup module.
+
+See:
+https://packaging.python.org/en/latest/distributing.html
+https://github.com/pypa/sampleproject
+
+Extra supported commands are:
+* gen, to generate the classes required for spluspy to run or docs
+* pypi, to generate sdist, bdist_wheel, and push to PyPi
+"""
+
+import itertools
+import json
+import os
+import re
+import shutil
+import sys
+import urllib.request
+from pathlib import Path
+from subprocess import run
+
+from setuptools import find_packages, setup
+
+# Needed since we're importing local files
+sys.path.insert(0, os.path.dirname(__file__))
+
+class TempWorkDir:
+    """Switches the working directory to be the one on which this file lives,
+       while within the 'with' block.
+    """
+    def __init__(self, new=None):
+        self.original = None
+        self.new = new or str(Path(__file__).parent.resolve())
+
+    def __enter__(self):
+        # os.chdir does not work with Path in Python 3.5.x
+        self.original = str(Path('.').resolve())
+        os.makedirs(self.new, exist_ok=True)
+        os.chdir(self.new)
+        return self
+
+    def __exit__(self, *args):
+        os.chdir(self.original)
+
+
+API_REF_URL = 'https://tl.spluspy.dev/'
+
+GENERATOR_DIR = Path('spluspy_generator')
+LIBRARY_DIR = Path('spluspy')
+
+ERRORS_IN = GENERATOR_DIR / 'data/errors.csv'
+ERRORS_OUT = LIBRARY_DIR / 'errors/rpcerrorlist.py'
+
+METHODS_IN = GENERATOR_DIR / 'data/methods.csv'
+
+# Which raw API methods are covered by *friendly* methods in the client?
+FRIENDLY_IN = GENERATOR_DIR / 'data/friendly.csv'
+
+TLOBJECT_IN_TLS = [Path(x) for x in GENERATOR_DIR.glob('data/*.tl')]
+TLOBJECT_OUT = LIBRARY_DIR / 'tl'
+IMPORT_DEPTH = 2
+
+DOCS_IN_RES = GENERATOR_DIR / 'data/html'
+DOCS_OUT = Path('docs')
+
+
+def generate(which, action='gen'):
+    from spluspy_generator.parsers import\
+        parse_errors, parse_methods, parse_tl, find_layer
+
+    from spluspy_generator.generators import\
+        generate_errors, generate_tlobjects, generate_docs, clean_tlobjects
+
+    layer = next(filter(None, map(find_layer, TLOBJECT_IN_TLS)))
+    errors = list(parse_errors(ERRORS_IN))
+    methods = list(parse_methods(METHODS_IN, FRIENDLY_IN, {e.str_code: e for e in errors}))
+
+    tlobjects = list(itertools.chain(*(
+        parse_tl(file, layer, methods) for file in TLOBJECT_IN_TLS)))
+
+    if not which:
+        which.extend(('tl', 'errors'))
+
+    clean = action == 'clean'
+    action = 'Cleaning' if clean else 'Generating'
+
+    if 'all' in which:
+        which.remove('all')
+        for x in ('tl', 'errors', 'docs'):
+            if x not in which:
+                which.append(x)
+
+    if 'tl' in which:
+        which.remove('tl')
+        print(action, 'TLObjects...')
+        if clean:
+            clean_tlobjects(TLOBJECT_OUT)
+        else:
+            generate_tlobjects(tlobjects, layer, IMPORT_DEPTH, TLOBJECT_OUT)
+
+    if 'errors' in which:
+        which.remove('errors')
+        print(action, 'RPCErrors...')
+        if clean:
+            if ERRORS_OUT.is_file():
+                ERRORS_OUT.unlink()
+        else:
+            with ERRORS_OUT.open('w') as file:
+                generate_errors(errors, file)
+
+    if 'docs' in which:
+        which.remove('docs')
+        print(action, 'documentation...')
+        if clean:
+            if DOCS_OUT.is_dir():
+                shutil.rmtree(str(DOCS_OUT))
+        else:
+            in_path = DOCS_IN_RES.resolve()
+            with TempWorkDir(DOCS_OUT):
+                generate_docs(tlobjects, methods, layer, in_path)
+
+    if 'json' in which:
+        which.remove('json')
+        print(action, 'JSON schema...')
+        json_files = [x.with_suffix('.json') for x in TLOBJECT_IN_TLS]
+        if clean:
+            for file in json_files:
+                if file.is_file():
+                    file.unlink()
+        else:
+            def gen_json(fin, fout):
+                meths = []
+                constructors = []
+                for tl in parse_tl(fin, layer):
+                    if tl.is_function:
+                        meths.append(tl.to_dict())
+                    else:
+                        constructors.append(tl.to_dict())
+                what = {'constructors': constructors, 'methods': meths}
+                with open(fout, 'w') as f:
+                    json.dump(what, f, indent=2)
+
+            for fs in zip(TLOBJECT_IN_TLS, json_files):
+                gen_json(*fs)
+
+    if which:
+        print(
+            'The following items were not understood:', which,
+            '\n  Consider using only "tl", "errors" and/or "docs".'
+            '\n  Using only "clean" will clean them. "all" to act on all.'
+            '\n  For instance "gen tl errors".'
+        )
+
+
+def main(argv):
+    if len(argv) >= 2 and argv[1] in ('gen', 'clean'):
+        generate(argv[2:], argv[1])
+
+    elif len(argv) >= 2 and argv[1] == 'pypi':
+        # Make sure tl.spluspy.dev is up-to-date first
+        with urllib.request.urlopen(API_REF_URL) as resp:
+            html = resp.read()
+            m = re.search(br'layer\s+(\d+)', html)
+            if not m:
+                print('Failed to check that the API reference is up to date:', API_REF_URL)
+                return
+
+            from spluspy_generator.parsers import find_layer
+            layer = next(filter(None, map(find_layer, TLOBJECT_IN_TLS)))
+            published_layer = int(m[1])
+            if published_layer != layer:
+                print('Published layer', published_layer, 'does not match current layer', layer, '.')
+                print('Make sure to update the API reference site first:', API_REF_URL)
+                return
+
+        # (Re)generate the code to make sure we don't push without it
+        generate(['tl', 'errors'])
+
+        # Try importing the spluspy module to assert it has no errors
+        try:
+            import spluspy
+        except Exception as e:
+            print('Packaging for PyPi aborted, importing the module failed.')
+            print(e)
+            return
+
+        remove_dirs = ['__pycache__', 'build', 'dist', 'spluspy.egg-info']
+        for root, _dirs, _files in os.walk(LIBRARY_DIR, topdown=False):
+            # setuptools is including __pycache__ for some reason (#1605)
+            if root.endswith('/__pycache__'):
+                remove_dirs.append(root)
+        for x in remove_dirs:
+            shutil.rmtree(x, ignore_errors=True)
+
+        run('python3 setup.py sdist', shell=True)
+        run('python3 setup.py bdist_wheel', shell=True)
+        run('twine upload dist/*', shell=True)
+        for x in ('build', 'dist', 'spluspy.egg-info'):
+            shutil.rmtree(x, ignore_errors=True)
+
+    else:
+        # e.g. install from GitHub
+        if GENERATOR_DIR.is_dir():
+            generate(['tl', 'errors'])
+
+        # Get the long description from the README file
+        with open('README.rst', 'r', encoding='utf-8') as f:
+            long_description = f.read()
+
+        with open('spluspy/version.py', 'r', encoding='utf-8') as f:
+            version = re.search(r"^__version__\s*=\s*'(.*)'.*$",
+                                f.read(), flags=re.MULTILINE).group(1)
+        setup(
+            name='spluspy',
+            version=version,
+            description="Soroush Plus library for Python",
+            long_description=long_description,
+
+            url='https://github.com/Itskillmaster/spluspy',
+            download_url='https://github.com/Itskillmaster/spluspy/releases',
+
+            author='AliMirshekari And Soroush Fathi',
+            author_email='dramff1@gmail.com',
+
+            license='GPL-3.0',
+
+            # See https://stackoverflow.com/a/40300957/4759433
+            # -> https://www.python.org/dev/peps/pep-0345/#requires-python
+            # -> http://setuptools.readthedocs.io/en/latest/setuptools.html
+            python_requires='>=3.5',
+
+            # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
+            classifiers=[
+                #   3 - Alpha
+                #   4 - Beta
+                #   5 - Production/Stable
+                'Development Status :: 5 - Production/Stable',
+
+                'Intended Audience :: Developers',
+                'Topic :: Communications :: Chat',
+
+                'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
+
+                'Programming Language :: Python :: 3',
+                'Programming Language :: Python :: 3.5',
+                'Programming Language :: Python :: 3.6',
+                'Programming Language :: Python :: 3.7',
+                'Programming Language :: Python :: 3.8',
+            ],
+            keywords='telegram api chat client library messaging mtproto',
+            packages=find_packages(exclude=[
+                'spluspy_*', 'tests*'
+            ]),
+            install_requires=['pyaes', 'rsa', 'websockets'],
+            extras_require={
+                'cryptg': ['cryptg']
+            }
+        )
+
+
+if __name__ == '__main__':
+    with TempWorkDir():
+        main(sys.argv)

spluspy-1.0.0/spluspy/__init__.py

@@ -0,0 +1,20 @@
+from .client.soroushclient import SoroushClient
+from .network import connection
+from .tl.custom import Button
+from .tl import patched as _  # import for its side-effects
+from . import version, events, utils, errors, types, functions, custom
+from .sessions import Session, MemorySession, SQLiteSession, StringSession
+from .tl.custom import Conversation, Message, Dialog, Forward, Draft
+
+__version__ = version.__version__
+
+# Convenience alias
+Client = SoroushClient
+
+__all__ = [
+    'Client', 'SoroushClient', 'Button',
+    'Session', 'MemorySession', 'SQLiteSession', 'StringSession',
+    'Conversation', 'Message', 'Dialog', 'Forward', 'Draft',
+    'types', 'functions', 'custom', 'errors',
+    'events', 'utils', 'connection'
+]

spluspy-1.0.0/spluspy/_updates/__init__.py

@@ -0,0 +1,3 @@
+from .entitycache import EntityCache
+from .messagebox import MessageBox, GapError, PrematureEndReason
+from .session import SessionState, ChannelState, Entity, EntityType

spluspy-1.0.0/spluspy/_updates/entitycache.py

@@ -0,0 +1,59 @@
+from .session import EntityType, Entity
+
+
+_sentinel = object()
+
+
+class EntityCache:
+    def __init__(
+        self,
+        hash_map: dict = _sentinel,
+        self_id: int = None,
+        self_bot: bool = None
+    ):
+        self.hash_map = {} if hash_map is _sentinel else hash_map
+        self.self_id = self_id
+        self.self_bot = self_bot
+
+    def set_self_user(self, id, bot, hash):
+        self.self_id = id
+        self.self_bot = bot
+        if hash:
+            self.hash_map[id] = (hash, EntityType.BOT if bot else EntityType.USER)
+
+    def get(self, id):
+        try:
+            hash, ty = self.hash_map[id]
+            return Entity(ty, id, hash)
+        except KeyError:
+            return None
+
+    def extend(self, users, chats):
+        # See https://core.telegram.org/api/min for "issues" with "min constructors".
+        self.hash_map.update(
+            (u.id, (
+                u.access_hash,
+                EntityType.BOT if u.bot else EntityType.USER,
+            ))
+            for u in users
+            if getattr(u, 'access_hash', None) and not u.min
+        )
+        self.hash_map.update(
+            (c.id, (
+                c.access_hash,
+                EntityType.MEGAGROUP if c.megagroup else (
+                    EntityType.GIGAGROUP if getattr(c, 'gigagroup', None) else EntityType.CHANNEL
+                ),
+            ))
+            for c in chats
+            if getattr(c, 'access_hash', None) and not getattr(c, 'min', None)
+        )
+
+    def put(self, entity):
+        self.hash_map[entity.id] = (entity.hash, entity.ty)
+
+    def retain(self, filter):
+        self.hash_map = {k: v for k, v in self.hash_map.items() if filter(k)}
+
+    def __len__(self):
+        return len(self.hash_map)