nejma

ناجما

مستوحاة من channels ، يتيح لك Nejma إدارة الرسائل وإرسالها إلى مجموعات من القنوات

الأشياء التي يمكنك بناءها مع nejma :

• محادثة
• إشعار
• التعامل مع المستخدمين المتصلين من علامات تبويب متعددة)
• وأكثر ...

مثال

ألقِ نظرة على هذا المثال nejma-chat ، وهو تطبيق دردشة بسيط تم تصميمه باستخدام nejma و starlette .

تثبيت

$ pip install nejma

ابدء

إليك مثال على استخدام nejma مع WebSockets.

أول قناة استيراد و channel_layer من Nejma

 from nejma import Channel , channel_layer

قم بإنشاء قناة على الاتصال

 async def on_connect ( self , websocket , ** kwargs ):
    await super (). on_connect ( websocket , ** kwargs )

    self . channel = Channel ( send = websocket . send )

أضف مجموعات أو قنوات أو إرسال رسائل

 async def on_receive ( self , websocket , data ):
    self . channel_layer . add ( group , self . channel )

    await self . channel_layer . group_send ( group , "Welcome !" )

Finnaly ، قم بإزالة القناة بمجرد إغلاق الاتصال

 async def on_disconnect ( self , websocket , close_code ):
    self . channel_layer . remove_channel ( self . channel )

Starlette

---

لاستخدام nejma مع starlette ، ما عليك سوى استيراد WebSocketEndPoint من Nejma

 from nejma . ext . starlette import WebSocketEndpoint

@ app . websocket_route ( "/ws" )
class Chat ( WebSocketEndpoint ):
    encoding = "json"

    async def on_receive ( self , websocket , data ):
        room_id = data [ 'room_id' ]
        message = data [ 'message' ]
        username = data [ 'username' ]

        if message . strip ():
            group = f"group_ { room_id } "

            self . channel_layer . add ( group , self . channel )

            payload = {
                "username" : username ,
                "message" : message ,
                "room_id" : room_id
            }
            await self . channel_layer . group_send ( group , payload )

مستندات

تعرض فئة ChannelLayer التي توفرها nejma الطرق التالية:

add(group, channel, send=None)

يضيف قناة إلى مجموعة العطاء.

• إرسال: طريقة لإرسال الرسائل إلى قناة

 self . channel_layer . add ( group , self . channel , send = websocket . send )

async group_send(group, "Welcome !")

يرسل رسالة إلى مجموعة من القنوات

 await self . channel_layer . group_send ( group , "Welcome !" )

remove(group, channel)

يزيل قناة من مجموعة معينة

 self . channel_layer . remove ( group , self . channel )

remove_channel(channel)

يزيل قناة من جميع المجموعات

 self . channel_layer . remove_channel ( self . channel )

flush()

أعد ضبط جميع المجموعات

 self . channel_layer . flush ()