基于telepath库实现Python和JavaScript之间交换数据
它有什么作用？
它提供了一种将包括Python对象在内的结构化数据打包为JSON可序列化格式的机制。通过向相应的JavaScript实现注册该机制，可以扩展该机制以支持任何Python类。然后，打包的数据可以包含在HTTP响应中，并在JavaScript中解压缩以获得与原始数据等效的数据结构。
安装方法
pip install telepath
并将'telepath'添加到项目的INSTALLED_APPS。
简介
假设我们正在构建一个用于玩跳棋的Django应用。我们已经花费了数天或数周的时间，构建了游戏规则的Python实现，并提供了代表当前游戏状态和各个部分的类。但是，我们还希望为播放器提供一个适当友好的用户界面，这意味着该是我们编写JavaScript前端的时候了。我们的UI代码不可避免地将拥有自己的对象，这些对象代表不同的角色，镜像我们正在服务器上跟踪的数据结构——但我们无法发送Python对象，因此将这些数据发送到客户端通常将意味着设计游戏状态的JSON表示形式，并在两端分别设计大量样式代码，遍历数据结构以在本机对象之间来回转换。让我们看看telepath如何简化该过程。
一个完整的跳棋游戏对于本教程来说有点太多了，所以我们只选择渲染这一步...
在Python环境中，创建一个新的Django项目：
pip install "Django>=3.1,<3.2" django-admin startproject draughts cd draughts ./manage.py startapp games
在draughts / settings.py的INSTALLED_APPS列表中添加'games'。
为简单起见，在本示例中，我们将不涉及数据库，而是将游戏状态表示为普通的Python类而不是Django模型。修改games/views.py，如下所示：
from django.shortcuts import render
class Piece:
def __init__(self, color, position):
self.color = color
self.position = position
class GameState:
def __init__(self, pieces):
self.pieces = pieces
@staticmethod
def new_game():
black_pieces = [
Piece('black', (x, y))
for y in range(0, 3)
for x in range((y + 1) % 2, 8, 2)
]
white_pieces = [
Piece('white', (x, y))
for y in range(5, 8)
for x in range((y + 1) % 2, 8, 2)
]
return GameState(black_pieces + white_pieces)
def game(request):
game_state = GameState.new_game()
return render(request, 'game.html', {})
如下所示创建games/templates/game.html：
<!doctype html>
<html>
<head>
<title>Draughts</title>
<script>
document.addEventListener('DOMContentLoaded', event => {
const gameElement = document.getElementById('game');
gameElement.innerHTML = 'TODO: render the board here'
});
</script>
</head>
<body>
<h1>Draughts</h1>
<div id="game">
</div>
</body>
</html>
将新视图添加到draughts/urls.py:
from django.contrib import admin
from django.urls import path
from games.views import game
urlpatterns = [
path('', game),
path('admin/', admin.site.urls),
]
现在，使用./manage.py runserver启动服务器，并访问http：// localhost：8000 /。
到目前为止，我们已经创建了一个代表新游戏的GameState对象——现在是时候引入telepath，以便我们可以将该对象传输到客户端。执行下面命令：
pip install telepath
并将'telepath'添加到draughts / settings.py中的INSTALLED_APPS列表中。现在编辑games/views.py文件：
import json
from django.shortcuts import render
from telepath import JSContext
# ...
def game(request):
game_state = GameState.new_game()
js_context = JSContext()
packed_game_state = js_context.pack(game_state)
game_state_json = json.dumps(packed_game_state)
return render(request, 'game.html', {
'game_state_json': game_state_json,
})
这里JSContext是一个帮助工具，用于管理游戏状态对象到我们可以在Javascript中使用的表示形式的转换。js_context.pack接受该对象并将其转换为可以JSON序列化并传递到我们的模板的值。但是，现在重新加载页面失败，并出现以下形式的错误：don't know how to pack object: <games.views.GameState object at 0x10f3f2490>
这是因为GameState是Telepath尚不知道如何处理的自定义Python类型。传递给pack的任何自定义类型必须链接到相应的JavaScript实现；这是通过定义Adapter对象并将其注册到telepath来完成的。如下更新game / views.py：
import json from django.shortcuts import render from telepath import Adapter, JSContext, register # ... class GameState: # keep definition as before class GameStateAdapter(Adapter): js_constructor = 'draughts.GameState' def js_args(self, game_state): return [game_state.pieces] class Media: js = ['draughts.js'] register(GameStateAdapter(), GameState)
此处js_constructor是JavaScript构造函数的标识符，该标识符将用于在客户端上构建GameState实例，并且js_args定义了将传递给此构造函数的参数列表，以重新创建给定game_state对象的JavaScript对应对象 。Media类指示文件，该文件遵循Django对格式媒体的约定，可在其中找到GameState的JavaScript实现。稍后我们将看到此JavaScript实现的外观，现在，我们需要为Piece类定义一个类似的适配器，因为我们对GameStateAdapter的定义取决于是否能够打包Piece实例。将以下定义添加到games/views.py：
class Piece: # keep definition as before class PieceAdapter(Adapter): js_constructor = 'draughts.Piece' def js_args(self, piece): return [piece.color, piece.position] class Media: js = ['draughts.js'] register(PieceAdapter(), Piece)
重新加载页面，您将看到错误提示消失了，这表明我们已成功将GameState对象序列化为JSON并将其传递给模板。现在，我们可以将其包含在模板中-编辑games/templates/game.html：
<body>
<h1>Draughts</h1>
<div id="game" data-game-state="{{ game_state_json }}">
</div>
</body>
再次重新加载页面，并在浏览器的开发人员工具中检查游戏元素（在Chrome和Firefox中，右键单击TODO注释，然后选择Inspect或Inspect Element），您将看到GameState对象的JSON表示，准备好 解压成完整的JavaScript对象。
除了将数据打包成JSON可序列化的格式外，JSContext对象还跟踪将数据解压缩所需的JavaScript媒体定义，作为其媒体属性。让我们更新游戏视图，以将其也传递给模板-在games/views.py中：
def game(request):
game_state = GameState.new_game()
js_context = JSContext()
packed_game_state = js_context.pack(game_state)
game_state_json = json.dumps(packed_game_state)
return render(request, 'game.html', {
'game_state_json': game_state_json,
'media': js_context.media,
})
将下面代码添加到games / templates / game.html中的HTML头文件中：
<head>
<title>Draughts</title>
{{ media }}
<script>
document.addEventListener('DOMContentLoaded', event => {
const gameElement = document.getElementById('game');
gameElement.innerHTML = 'TODO: render the board here'
});
</script>
</head>
重新加载页面并查看源代码，您将看到这带来了两个JavaScript包括 —— telepath.js（客户端telepath库，提供解包机制）和我们在适配器定义中指定的draughts.js文件。后者尚不存在，所以让我们在games / static / draughts.js中创建它：
class Piece {
constructor(color, position) {
this.color = color;
this.position = position;
}
}
window.telepath.register('draughts.Piece', Piece);
class GameState {
constructor(pieces) {
this.pieces = pieces;
}
}
window.telepath.register('draughts.GameState', GameState);
这两个类定义实现了我们先前在适配器对象中声明的构造函数-构造函数接收的参数是js_args定义的参数。window.telepath.register行将这些类定义附加到通过js_constructor指定的相应标识符。现在，这为我们提供了解压缩JSON所需的一切-回到games / templates / game.html中，更新JS代码，如下所示：
<script>
document.addEventListener('DOMContentLoaded', event => {
const gameElement = document.getElementById('game');
const gameStateJson = gameElement.dataset.gameState;
const packedGameState = JSON.parse(gameStateJson);
const gameState = window.telepath.unpack(packedGameState);
console.log(gameState);
})
</script>
您可能需要重新启动服务器以获取新的games/static文件夹。重新加载页面，然后在浏览器控制台中，您现在应该看到填充了Piece对象的GameState对象。现在，我们可以继续在games/static/draughts.js中填写渲染代码：
class Piece {
constructor(color, position) {
this.color = color;
this.position = position;
}
render(container) {
const element = document.createElement('div');
container.appendChild(element);
element.style.width = element.style.height = '24px';
element.style.border = '2px solid grey';
element.style.borderRadius = '14px';
element.style.backgroundColor = this.color;
}
}
window.telepath.register('draughts.Piece', Piece)
class GameState {
constructor(pieces) {
this.pieces = pieces;
}
render(container) {
const table = document.createElement('table');
container.appendChild(table);
const cells = [];
for (let y = 0; y < 8; y++) {
let row = document.createElement('tr');
table.appendChild(row);
cells[y] = [];
for (let x = 0; x < 8; x++) {
let cell = document.createElement('td');
row.appendChild(cell);
cells[y][x] = cell;
cell.style.width = cell.style.height = '32px';
cell.style.backgroundColor = (x + y) % 2 ? 'silver': 'white';
}
}
this.pieces.forEach(piece => {
const [x, y] = piece.position;
const cell = cells[y][x];
piece.render(cell);
});
}
}
window.telepath.register('draughts.GameState', GameState)
在games/templates/game.html中添加对render方法的调用：
<script>
document.addEventListener('DOMContentLoaded', event => {
const gameElement = document.getElementById('game');
const gameStateJson = gameElement.dataset.gameState;
const packedGameState = JSON.parse(gameStateJson);
const gameState = window.telepath.unpack(packedGameState);
gameState.render(gameElement);
})
</script>
重新加载页面，您将看到我们的跳棋程序已准备就绪，可以开始游戏了。
让我们快速回顾一下我们已经取得的成果：
- 我们已经打包和解包了自定义Python / JavaScript类型的数据结构，而无需编写代码来递归该结构。如果我们的GameState对象变得更复杂（例如，“棋子”列表可能变成棋子和国王对象的混合列表，或者状态可能包括游戏历史），则无需重构任何数据打包/拆包逻辑，除了为每个使用的类提供一个适配器对象。
- 仅提供了解压缩页面数据所需的JS文件-如果我们的游戏应用程序扩展到包括Chess，Go和Othello，并且所有生成的类都已通过Telepath注册，则我们仍然只需要提供与跳棋知识相关的代码。
- 即使我们使用任意对象，也不需要动态内联JavaScript —— 所有动态数据都以JSON形式传递，并且所有JavaScript代码在部署时都是固定的（如果我们的网站强制执行CSP，这一点很重要）。
以上就是基于telepath库实现Python和JavaScript之间交换数据的详细内容，更多关于Python和JavaScript之间交换数据的资料请关注我们其它相关文章！
相关推荐
-
Python 如何保存json文件并格式化
背景 最近自己搞些小东西,需要用json文件存储些文件属性什么的,但是发现用json包里的json.dump()方法存json文件的效果好丑--(其实是没仔细看方法), 于是上网找了一份格式化json文件的代码,效果挺不错,用了递归的思想,学习了一波并找到了其中一点小bug.然后,发现其实json.dump()方法其实只需要设置一个参数就达到格式化的效果了-- 下面介绍一下json.dump()和我修改后的那份代码,附原github地址. json.dump() 直接把常用参数列一下好了 参数名
-
Python3中对json格式数据的分析处理
前言 数据已经过修改,以防泄密,请放心阅读 今天同事提出一个需求,要求我修改之前的某脚本,该脚本的作用是获取zabbix监控系统返回的json数据,我的任务是使其变成易读的文本,如何获取数据不在此赘述,只描述如何对json数据进行处理 一.如何将json数据转换成python内部的数据类型 展示一下zabbix的接口返回的json数据(数据经过dumps编码了,因为原数据为str类型,只有一行,不易读) js = json.dumps(get_alert(), indent=4, ensure_
-
Python解析JSON对象的全过程记录
前言 本章节我们将为大家介绍如何使用 Python 语言来编码和解码 JSON 对象. json处理模块的主要任务,是将一个JSON对象,转换成Python数据类型数据进行处理,或者反之,将Python数据类型数据,转换成JSON对象(字符串流),在不同的模块或者系统间传输. 1. JSON数据格式特点 对象表示为键值对 数据由逗号分隔 花括号保存对象 方括号保存数组 { "students": [ { "name":"北山啦" , "
-
Python如何把不同类型数据的json序列化
现代网络应用Web APP或大型网站的后台一般只有一个,然后客户端却是各种各样的(iOS, android, 浏览器), 而且客户端的开发语言很可能与后台的开发语言不一样.这时我们需要后台能够提供可以跨平台跨语言的一种标准的数据交换格式供前后端沟通(这就是Web API的作用).如今大家最常用的跨平台跨语言数据交换格式就是JSON(JavaScript Object Notation)了.JSON是一种文本序列化格式(它输出的是unicode文件,大多数时候会被编码为utf-8),人们很容易进行
-
python 调用js的四种方式
1. 前言 日常 Web 端爬虫过程中,经常会遇到参数被加密的场景,因此,我们需要分析网页源代码 通过调式,一层层剥离出关键的 JS 代码,使用 Python 去执行这段代码,得出参数加密前后的 Python 实现 本文将聊聊利用 Python 调用 JS 的4种方式 2. 准备 以一段简单的 JS 脚本为例,将代码写入到文件中 //norm.js //计算两个数的和 function add(num1, num2) { return num1 + num2; } 其中,定义了一个方法,
-
python执行js代码的方法
什么是js代码混淆? 正常代码 我们现在看一段js代码,代码逻辑很简单,就是拼接时间返回. function formatDate(now) { var now = new Date(1230999938); var year=now.getFullYear(); var month=now.getMonth()+1; var date=now.getDate(); var hour=now.getHours(); var minute=now.getMinutes(); var second=
-
使用python把json文件转换为csv文件
了解json整体格式 这里有一段json格式的文件,存着全球陆地和海洋的每年异常气温(这里只选了一部分):global_temperature.json { "description": { "title": "Global Land and Ocean Temperature Anomalies, January-December", "units": "Degrees Celsius", "b
-
python实现xml转json文件的示例代码
使用了Python的 xml.etree.ElementTree 库 xml.etree.ElementTree 库简介 xml.etree.ElementTree模块实现了一个简单而高效的API用于解析和创建XML数据.xml.etree.ElementTree模块对于恶意构造的数据是不安全的.如果您需要解析不受信任或未经验证的数据,请参阅XML漏洞. 参考文献:https://docs.python.org/3.6/library/xml.etree.elementtree.html fro
-
Python中json.dumps()函数的使用解析
json.dumps将一个Python数据结构转换为JSON import json data = { 'name' : 'myname', 'age' : 100, } json_str = json.dumps(data) json库的一些用法 方法 作用 json.dumps() 将python对象编码成Json字符串 json.loads() 将Json字符串解码成python对象 json.dump() 将python中的对象转化成json储存到文件中 json.load() 将文件中
-
Python实现学生管理系统的代码(JSON模块)
构思 学生管理系统 应该包含老师注册登录 管理学生信息(增删改查)还有数据持久化 因为数据存入JSON文件 增删改查都需要读取和修改文件 所以需要一个读写文件的方法文件 file_manager 密码加密可以用到哈希模块文件 tools 老师和学生的类文件 model 程序入口(主页)文件index 核心增删改查文件 student_manager file_manager.py """ Project: ClassStudent Creator: 猫猫 Create tim