简介 ​

什么是 Vue.py？ ​

Vue.py (发音为 /vjuːpaɪ/，类似 viewpy) 是一款用于构建用户界面的 Python 框架。它基于标准 HTML、CSS 和 Python 构建，并提供了一套声明式的、组件化的编程模型，帮助你高效地开发用户界面。无论是简单还是复杂的界面，Vue.py 都可以胜任。

下面是一个最基本的示例：

from vuepy import ref, create_app

def setup(*args):
    count = ref(0)
    
    def counter():
        count.value += 1
    
    return locals()


app = create_app({
    'setup': setup,
    'template': '''
    <Button :label="f'Count is: {count.value}'" 
      @click='counter()'
    ></Button>
    '''
})
app.mount()

结果展示

上面的示例展示了 Vue.py 的两个核心功能：

• 声明式渲染：Vue.py 基于标准 HTML 拓展了一套模板语法，使得我们可以声明式地描述最终输出的 HTML 和 Python 状态之间的关系。

• 响应性：Vue.py 会自动跟踪 Python 状态并在其发生变化时响应式地更新 DOM。

你可能已经有了些疑问——先别急，在后续的文档中我们会详细介绍每一个细节。现在，请继续看下去，以确保你对 Vue.py 作为一个框架到底提供了什么有一个宏观的了解。

渐进式框架 ​

Vue.py 是一个框架，也是一个生态。其功能覆盖了大部分前端开发常见的需求。但 Web 世界是十分多样化的，不同的开发者在 Web 上构建的东西可能在形式和规模上会有很大的不同。考虑到这一点，Vue.py 的设计非常注重灵活性和“可以被逐步集成”这个特点。根据你的需求场景，你可以用不同的方式使用 Vue.py：

• 无需构建步骤，渐进式增强静态的 HTML
• 在任何页面中作为 Web Components 嵌入
• 单页应用 (SPA)

如果你是初学者，可能会觉得这些概念有些复杂。别担心！理解教程和指南的内容只需要具备基础的 HTML 和 Python 知识。即使你不是这些方面的专家，也能够跟得上。

如果你是有经验的开发者，希望了解如何以最合适的方式在项目中引入 Vue.py，或者是对上述的这些概念感到好奇，我们在使用 Vue.py 的多种方式中讨论了有关它们的更多细节。

无论再怎么灵活，Vue.py 的核心知识在所有这些用例中都是通用的。即使你现在只是一个初学者，随着你的不断成长，到未来有能力实现更复杂的项目时，这一路上获得的知识依然会适用。如果你已经是一个老手，你可以根据实际场景来选择使用 Vue.py 的最佳方式，在各种场景下都可以保持同样的开发效率。这就是为什么我们将 Vue.py 称为“渐进式框架”：它是一个可以与你共同成长、适应你不同需求的框架。

单文件组件 ​

我们可以使用一种类似 HTML 格式的文件来书写 Vue.py 组件，它被称为单文件组件 (也被称为 *.vue 文件，英文 Single-File Components，缩写为 SFC)。顾名思义，Vue.py 的单文件组件会将一个组件的逻辑 (Python)，模板 (HTML) 和样式 (CSS) 封装在同一个文件里。下面我们将用单文件组件的格式重写上面的计数器示例：

<template>
  <Button :label="f'Count is: {count.value}'"
          @click='counter()'
  ></Button>
</template>

<script setup lang='py'>
from vuepy import ref

def setup(*args):
    count = ref(0)

    def counter():
        count.value += 1

    return locals()

</script>

<style scoped>
</style>

单文件组件是 Vue.py 的标志性功能。如果你的用例需要进行构建，我们推荐用它来编写 Vue.py 组件。你可以在后续相关章节里了解更多关于单文件组件的用法及用途。但你暂时只需要知道 Vue.py 会帮忙处理所有这些构建工具的配置就好。

API 风格 ​

Vue 的组件可以按组合式 API的风格书写。

组合式 API (Composition API) ​

通过组合式 API，我们可以使用导入的 API 函数来描述组件逻辑。在单文件组件中，组合式 API 通常会与 <script setup> 搭配使用。这个 setup attribute 是一个标识，告诉 Vue.py 需要在编译时进行一些处理，让我们可以更简洁地使用组合式 API。比如，<script setup> 中的导入和顶层变量/函数都能够在模板中直接使用。

下面是使用了组合式 API 与 <script setup> 的组件：

<template>
  <Button :label="f'Count is: {count.value}'"
          @click='increment()'
  ></Button>
</template>

<script setup lang='py'>
from vuepy import ref, on_mounted

def setup(*args):
    # 响应式状态
    count = ref(0)

    # 用来修改状态、触发更新的函数
    def increment():
        count.value += 1

    return locals()
 
    # 什么周期钩子 todo
    on_mounted()

</script>

<style scoped>
</style>

还有其他问题？ ​

请查看我们的 FAQ。

选择你的学习路径 ​

不同的开发者有不同的学习方式。尽管在可能的情况下，我们推荐你通读所有内容，但你还是可以自由地选择一种自己喜欢的学习路径！