Telethon

Telethon is Telegram client implementation in Python. This project's core is completely based on TLSharp. All the files which are fully based on it will have a notice on the top of the file. Also don't forget to have a look to the original project.

The files without the previously mentioned notice are no longer part of TLSharp itself, or have enough modifications to make them entirely different.

Requirements

This project requires the following Python modules, which can be installed by issuing sudo -H pip3 install <module> on a Linux terminal:

• pyaes (GitHub, package index)

Also, you need to obtain your both API ID and Hash. Once you have them, head to api/ and create a copy of the settings_example file, naming it settings (lowercase!). Then fill the file with the corresponding values (your api_id, api_hash and phone number in international format). Now it is when you're ready to go!

How to add more functions to TelegramClient

As of now, you cannot call any Telegram function unless you first write it by hand under tl/telegram_client.py. Why? Every Telegram function (or request) work in its own way. In some, you may only be interested in a single result field, and in others you may need to format the result in a different way. However, a plan for the future is to be able to call any function by giving its namespace.name and passing the arguments. But until that happens, to add a new function do:

1. Have a look under tl/functions/ and find the Request that suits your needs.
2. Have a look inside that Request you chose, and find what arguments and in what order you'll need to call it.
3. Import it in tl/telegram_client.py by using from tl.functions import SomeTelegramRequest.
4. Add a new method, or function, that looks as follows:

def my_function(self, my_arguments):
    request = SomeTelegramRequest(my_arguments)

    self.sender.send(request)
    self.sender.receive(request)
    
    return request.result

5. To determine how the result will look like, simply look at the original .tl definition. After the =, you will see the type. Let's see an example: stickerPack#12b299d4 emoticon:string documents:Vector<long> = StickerPack; As it turns out, the result is going to be an StickerPack. Without a second doubt, head into tl/types/ and find it; open the file and see what the result will look like. Alternatively, you can simply print(str(request.result))!

Be warned that there may be more than one different type on the results. This is due to Telegram's polymorphism, for example, a message may or not be empty, etc.

Plans for the future

If everything works well, this probably ends up being a Python package :)

But as of now, and until that happens, help is highly appreciated!

Code generator limitations

The current code generator is not complete, yet adding the missing features would only over-complicate an already hard-to-read code. Some parts of the .tl file should be omitted, because they're "built-in" in the generated code (such as writing booleans, etc.).

In order to make sure that all the generated files will work, please make sure to always comment out these lines in scheme.tl (the latest version can always be found here):

// boolFalse#bc799737 = Bool;
// boolTrue#997275b5 = Bool;
// true#3fedd339 = True;
// vector#1cb5c415 {t:Type} # [ t ] = Vector t;

Also please make sure to rename updates#74ae4240 ... to updates_tg#74ae4240 ... or similar to avoid confusion between the updates folder and the updates.py file!