Skip to content

Latest commit

 

History

History
263 lines (175 loc) · 9.39 KB

README.md

File metadata and controls

263 lines (175 loc) · 9.39 KB
+ 寻找 Pynecone 吗?您来对了.Pynecone 已经更名为 Reflex.+
Reflex Logo Reflex Logo

✨ 使用 Python 创建高效且可自定义的网页应用程序,几秒钟内即可部署.✨

PyPI version tests versions Documentaiton Discord


English | 简体中文 | 繁體中文 | Türkçe | हिंदी | Português (Brasil) | Italiano | Español | 한국어 | 日本語 | Deutsch


Reflex

Reflex 是一个使用纯Python构建全栈web应用的库。

关键特性:

  • 纯Python - 前端、后端开发全都使用Python,不需要学习Javascript。
  • 完整的灵活性 - Reflex很容易上手, 并且也可以扩展到复杂的应用程序。
  • 立即部署 - 构建后,使用单个命令就能部署应用程序;或者也可以将其托管在您自己的服务器上。

请参阅我们的架构页了解Reflex如何工作。

⚙️ 安装

打开一个终端并且运行(要求Python3.8+):

pip install reflex

🥳 创建您的第一个应用程序

安装 Reflex 的同时也会安装 reflex 命令行工具.

通过创建一个新项目来测试是否安装成功(请把 my_app_name 替代为您的项目名字):

mkdir my_app_name
cd my_app_name
reflex init

这段命令会在新文件夹初始化一个应用程序模板.

您可以在开发者模式下运行这个应用程序:

reflex run

您可以看到您的应用程序运行在 http:https://localhost:3000.

现在您可以在以下位置修改代码 my_app_name/my_app_name.py,Reflex 拥有快速刷新(fast refresh),所以您可以在保存代码后马上看到更改.

🫧 范例

让我们来看一个例子: 创建一个使用 DALL·E 进行图像生成的图形界面.为了保持范例简单,我们只使用 OpenAI API,但是您可以将其替换成本地端的 ML 模型.

 

DALL·E的前端界面, 展示了图片生成的进程

 

这是这个范例的完整代码,只需要一个 Python 文件就可以完成!

import reflex as rx
import openai

openai_client = openai.OpenAI()


class State(rx.State):
    """The app state."""
    
    prompt = ""
    image_url = ""
    processing = False
    complete = False

    def get_image(self):
        """Get the image from the prompt."""
        if self.prompt == "":
            return rx.window_alert("Prompt Empty")

        self.processing, self.complete = True, False
        yield
        response = openai_client.images.generate(
            prompt=self.prompt, n=1, size="1024x1024"
        )
        self.image_url = response.data[0].url
        self.processing, self.complete = False, True


def index():
    return rx.center(
        rx.vstack(
            rx.heading("DALL-E", font_size="1.5em"),
            rx.input(
                placeholder="Enter a prompt..",
                on_blur=State.set_prompt,
                width="25em",
            ),
            rx.button(
                "Generate Image", 
                on_click=State.get_image,
                width="25em",
                loading=State.processing
            ),
            rx.cond(
                State.complete,
                rx.image(src=State.image_url, width="20em"),
            ),
            align="center",
        ),
        width="100%",
        height="100vh",
    )

# Add state and page to the app.
app = rx.App()
app.add_page(index, title="Reflex:DALL-E")

让我们分解以上步骤.

解释 DALL-E app 的前端和后端部分的区别。

Reflex UI

让我们从UI开始.

def index():
    return rx.center(
        ...
    )

这个 index 函数定义了应用程序的前端.

我们用不同的组件比如 center, vstack, input, 和 button 来创建前端, 组件之间可以相互嵌入,来创建复杂的布局. 并且您可以使用关键字参数来使用 CSS 的全部功能.

Reflex 拥有 60+ 个内置组件 来帮助您开始创建应用程序. 我们正在积极添加组件, 但是您也可以容易的 创建自己的组件.

State

Reflex 用 State 来渲染您的 UI.

class State(rx.State):
    """The app state."""
    prompt = ""
    image_url = ""
    processing = False
    complete = False

State定义了所有可能会发生变化的变量(称为 vars)以及能够改变这些变量的函数.

在这个范例中,State由 promptimage_url 组成.此外,State还包含有两个布尔值 processingcomplete,用于指示何时显示循环进度指示器和图像.

Event Handlers

def get_image(self):
    """Get the image from the prompt."""
    if self.prompt == "":
        return rx.window_alert("Prompt Empty")

    self.processing, self.complete = True, False
    yield
    response = openai_client.images.generate(
        prompt=self.prompt, n=1, size="1024x1024"
    )
    self.image_url = response.data[0].url
    self.processing, self.complete = False, True

在 State 中,我们定义了称为事件处理器(event handlers)的函数,用于改变状态变量(state vars).在Reflex中,事件处理器是我们可以修改状态的方式.它们可以作为对用户操作的响应而被调用,例如点击一个按钮或在文本框中输入.这些操作被称为事件.

我们的DALL·E应用有一个事件处理器,名为 get_image,它用于从OpenAI API获取图像.在事件处理器中使用 yield 将导致UI进行更新.否则,UI将在事件处理器结束时进行更新.

Routing

最后,定义我们的应用程序.

app = rx.App()

我们添加从应用程序根目录到 index 组件的路由.我们还添加了一个在页面预览或浏览器标签中显示的标题.

app.add_page(index, title="DALL-E")

您可以通过增加更多页面来创建一个多页面的应用.

📑 资源

📑 文档   |   🗞️ 日志   |   📱 组件库   |   🖼️ 展览   |   🛸 部署  

✅ Reflex 的状态

Reflex 于 2022 年 12 月以Pynecone的名称推出.

截至2024年2月,我们的托管服务处于alpha测试阶段!在此期间,任何人都可以免费部署他们的应用程序。请查看我们的路线图以了解我们的计划。

Reflex 每周都有新功能和发布新版本! 确保您按下 ⭐ 收藏和 👀 关注 这个 仓库来确保知道最新信息.

贡献

我们欢迎任何大小的贡献,以下是几个好的方法来加入 Reflex 社群.

  • 加入我们的 Discord: 我们的 Discord 是帮助您加入 Reflex 项目和讨论或贡献最棒的地方.
  • GitHub Discussions: 一个来讨论您想要添加的功能或是需要澄清的事情的好地方.
  • GitHub Issues: 报告错误的绝佳地方,另外您可以试着解决一些 issue 和送出 PR.

我们正在积极寻找贡献者,无关您的技能或经验水平.

感谢我们所有的贡献者:

授权

Reflex 是一个开源项目,使用 Apache License 2.0 授权.