Merge branch 'main' into irc-ssl

Author: benjaoming

.editorconfig

@@ -10,11 +10,11 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 
-[*.{sh,py,pyi,js,json,yml,xml,css,md,markdown,handlebars,html}]
+[*.{sh,py,pyi,js,json,xml,css,md,markdown,handlebars,html}]
 indent_style = space
 indent_size = 4
 
-[*.{svg,rb,pp,pl}]
+[*.{svg,rb,pp,pl,yaml,yml}]
 indent_style = space
 indent_size = 2
 

.flake8

@@ -2,6 +2,10 @@
 ignore =
     # Each of these rules are ignored for the explained reason.
 
+    # "whitespace before ':'"
+    # Black disagrees with this.
+    E203,
+
     # "multiple spaces before operator"
     # There are several typos here, but also several instances that are
     # being used for alignment in dict keys/values using the `dict`

.github/FUNDING.yml

@@ -0,0 +1,3 @@
+github: zulip
+patreon: zulip
+open_collective: zulip

.github/workflows/zulip-tests.yml

@@ -0,0 +1,65 @@
+name: build
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  static-analysis:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup Python 3.6
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.6
+
+      - name: Install dependencies
+        run: tools/provision --force
+
+      - name: Running Test-Suite
+        run: |
+          source zulip-api-py3-venv/bin/activate
+          tools/lint --skip=gitlint
+
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python-version: [3.6, 3.7, 3.8, 3.9]
+        exclude:
+          - os: windows-latest
+            python-version: 3.6 # cryptography install fails on Windows with python 3.6 since pip is quite old.
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: python tools/provision --force
+
+      - if: runner.os == 'Linux'
+        name: Running Test-Suite on Linux
+        run: |
+          source zulip-api-py3-venv/bin/activate
+          pytest --cov --cov-config=tools/.coveragerc --cov-report=xml
+
+      - if: runner.os == 'Windows'
+        name: Running Test-Suite on Windows
+        run: |
+          zulip-api-py3-venv\Scripts\Activate.ps1
+          pytest --cov --cov-config=tools\.coveragerc --cov-report=xml
+
+      - uses: codecov/codecov-action@v2
+        with:
+          files: coverage.xml

.gitlint

@@ -0,0 +1,15 @@
+# This file is copied from the original .gitlint at zulip/zulip.
+# Please don't edit here; instead update the zulip/zulip copy and then resync this file.
+
+[general]
+ignore=title-trailing-punctuation, body-min-length, body-is-missing
+extra-path=tools/gitlint-rules.py
+
+[title-match-regex]
+regex=^(.+:\ )?[A-Z].+\.$
+
+[title-max-length]
+line-length=76
+
+[body-max-line-length]
+line-length=76

.travis.yml

@@ -1,7 +1,8 @@
 # Zulip API
 
-![Build status](https://travis-ci.org/zulip/python-zulip-api.svg?branch=master)
-[![Coverage status](https://img.shields.io/codecov/c/github/zulip/python-zulip-api/master.svg)](
+[![Build status](https://github.com/zulip/python-zulip-api/workflows/build/badge.svg)](
+https://github.com/zulip/python-zulip-api/actions?query=branch%3Amain+workflow%3Abuild)
+[![Coverage status](https://img.shields.io/codecov/c/github/zulip/python-zulip-api)](
 https://codecov.io/gh/zulip/python-zulip-api)
 
 This repository contains the source code for Zulip's PyPI packages:
@@ -21,17 +22,17 @@ This is part of the Zulip open source project; see the
 [contributing guide](https://zulip.readthedocs.io/en/latest/overview/contributing.html)
 and [commit guidelines](https://zulip.readthedocs.io/en/latest/contributing/version-control.html).
 
-1. Fork and clone the Git repo:
-   `git clone https://github.com/<your_username>/python-zulip-api.git`
-
-2. Make sure you have [pip](https://pip.pypa.io/en/stable/installing/)
-   and [virtualenv](https://virtualenv.pypa.io/en/stable/installation.html)
-   installed.
+1. Fork and clone the Git repo, and set upstream to zulip/python-zulip-api:
+   ```
+   git clone https://github.com/<your_username>/python-zulip-api.git
+   cd python-zulip-api
+   git remote add upstream https://github.com/zulip/python-zulip-api.git
+   git fetch upstream
+   ```
 
-3. `cd` into the repository cloned earlier:
-   `cd python-zulip-api`
+2. Make sure you have [pip](https://pip.pypa.io/en/stable/installing/).
 
-4. Run:
+3. Run:
    ```
    python3 ./tools/provision
    ```
@@ -42,14 +43,14 @@ and [commit guidelines](https://zulip.readthedocs.io/en/latest/contributing/vers
    python3 ./tools/provision -p <path_to_your_python_version>
    ```
 
-5. If that succeeds, it will end with printing the following command:
+4. If that succeeds, it will end with printing the following command:
    ```
    source /.../python-zulip-api/.../activate
    ```
    You can run this command to enter the virtual environment.
    You'll want to run this in each new shell before running commands from `python-zulip-api`.
 
-6. Once you've entered the virtualenv, you should see something like this on the terminal:
+5. Once you've entered the virtualenv, you should see something like this on the terminal:
    ```
    (zulip-api-py3-venv) user@pc ~/python-zulip-api $
    ```
@@ -58,13 +59,14 @@ and [commit guidelines](https://zulip.readthedocs.io/en/latest/contributing/vers
 
 ### Running tests
 
-To run the tests for
-
-* *zulip*: run `./tools/test-zulip`
+You can run all the tests with:
 
-* *zulip_bots*: run `./tools/test-lib && ./tools/test-bots`
+`pytest`
 
-* *zulip_botserver*: run `./tools/test-botserver`
+or test individual packages with `pytest zulip`, `pytest zulip_bots`,
+or `pytest zulip_botserver` (see the [pytest
+documentation](https://docs.pytest.org/en/latest/how-to/usage.html)
+for more options).
 
 To run the linter, type:
 

README.md

@@ -1,4 +1,6 @@
 [mypy]
+mypy_path = $MYPY_CONFIG_FILE_DIR/stubs
+
 check_untyped_defs = True
 disallow_any_generics = True
 strict_optional = True
@@ -9,3 +11,6 @@ scripts_are_modules = True
 show_traceback = True
 
 warn_no_return = True
+warn_redundant_casts = True
+warn_unused_ignores = True
+warn_unreachable = True

mypy.ini

@@ -0,0 +1,2 @@
+This is a boilerplate package for a Zulip bot that can be installed from pip
+and launched using the `zulip-run-bots` command.

packaged_helloworld/README.md

@@ -0,0 +1 @@
+__version__ = "1.0.0"

packaged_helloworld/packaged_helloworld/__init__.py

@@ -0,0 +1,5 @@
+Simple Zulip bot that will respond to any query with a "beep boop".
+
+The packaged_helloworld bot is a boilerplate bot that can be used as a
+template for more sophisticated/evolved Zulip bots that can be
+installed separately.

packaged_helloworld/packaged_helloworld/doc.md

@@ -0,0 +1,30 @@
+# See readme.md for instructions on running this code.
+from typing import Any, Dict
+
+import packaged_helloworld
+
+from zulip_bots.lib import BotHandler
+
+__version__ = packaged_helloworld.__version__
+
+
+class HelloWorldHandler:
+    def usage(self) -> str:
+        return """
+        This is a boilerplate bot that responds to a user query with
+        "beep boop", which is robot for "Hello World".
+
+        This bot can be used as a template for other, more
+        sophisticated, bots that can be installed separately.
+        """
+
+    def handle_message(self, message: Dict[str, Any], bot_handler: BotHandler) -> None:
+        content = "beep boop"  # type: str
+        bot_handler.send_reply(message, content)
+
+        emoji_name = "wave"  # type: str
+        bot_handler.react(message, emoji_name)
+        return
+
+
+handler_class = HelloWorldHandler

packaged_helloworld/packaged_helloworld/packaged_helloworld.py

@@ -0,0 +1,13 @@
+import packaged_helloworld
+from setuptools import find_packages, setup
+
+package_info = {
+    "name": "packaged_helloworld",
+    "version": packaged_helloworld.__version__,
+    "entry_points": {
+        "zulip_bots.registry": ["packaged_helloworld=packaged_helloworld.packaged_helloworld"],
+    },
+    "packages": find_packages(),
+}
+
+setup(**package_info)

packaged_helloworld/setup.py

@@ -0,0 +1,8 @@
+[tool.black]
+line-length = 100
+target-version = ["py36"]
+
+[tool.isort]
+src_paths = ["tools", "zulip", "zulip_bots", "zulip_botserver"]
+profile = "black"
+line_length = 100

pyproject.toml

@@ -1,11 +1,17 @@
 crayons
 twine
-coverage>=4.4.1
+black
+isort
 flake8
 mock
 pytest
+pytest-cov
 -e ./zulip
 -e ./zulip_bots
 -e ./zulip_botserver
--e git+https://github.com/zulip/zulint@639c0d34c23ac559ef0f7b9510cf95f73f6d0eb9#egg=zulint==1.0.0
-mypy==0.770
+-e git+https://github.com/zulip/zulint@14e3974001bf8442a6a3486125865660f1f2eb68#egg=zulint==1.0.0
+mypy==0.910
+types-python-dateutil
+types-pytz
+types-requests
+gitlint>=0.13.0

requirements.txt

@@ -0,0 +1,65 @@
+from typing import List, Optional, Sequence, Tuple, overload
+
+from typing_extensions import Literal
+
+class ZUid:
+    address: str
+    time: float
+
+class ZNotice:
+    kind: int
+    cls: str
+    instance: str
+    uid: ZUid
+    time: int
+    port: int
+    auth: bool
+    recipient: Optional[str]
+    sender: Optional[str]
+    opcode: Optional[str]
+    format: str
+    other_fields: List[str]
+    fields: List[str]
+    _charset: Optional[str]
+    def __init__(
+        self,
+        kind: int = ...,
+        cls: str = ...,
+        instance: str = ...,
+        uid: ZUid = ...,
+        time: int = ...,
+        port: int = ...,
+        auth: bool = ...,
+        recipient: Optional[str] = ...,
+        sender: Optional[str] = ...,
+        opcode: Optional[str] = ...,
+        format: str = ...,
+        other_fields: List[str] = ...,
+        fields: List[str] = ...,
+        _charset: Optional[str] = ...,
+        message: str = ...,
+    ): ...
+    def getmessage(self) -> str: ...
+    def setmessage(self, newmsg: str) -> None: ...
+    message = property(getmessage, setmessage)
+    @property
+    def charset(self) -> Optional[str]: ...
+    def send(self) -> None: ...
+
+def initialize() -> None: ...
+def openPort() -> int: ...
+def getFD() -> int: ...
+def setFD(fd: int) -> None: ...
+def sub(cls: str, instance: str, recipient: str) -> None: ...
+def subAll(lst: Sequence[Tuple[str, str, str]]) -> None: ...
+def unsub(cls: str, instance: str, recipient: str) -> None: ...
+def cancelSubs() -> None: ...
+@overload
+def receive(block: Literal[True]) -> ZNotice: ...
+@overload
+def receive(block: bool = ...) -> Optional[ZNotice]: ...
+def sender() -> str: ...
+def realm() -> str: ...
+def dump_session() -> bytes: ...
+def load_session(session: bytes) -> None: ...
+def getSubscriptions() -> List[Tuple[str, str, str]]: ...

stubs/_zephyr.pyi

@@ -0,0 +1,13 @@
+from typing import Set, Tuple
+
+import _zephyr
+from _zephyr import ZNotice as ZNotice
+from _zephyr import receive as receive
+
+_z = _zephyr
+__inited: bool
+
+def init() -> None: ...
+
+class Subscriptions(Set[Tuple[str, str, str]]):
+    pass