Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add wrappers around PyFrame and PyCode #225

Merged
merged 5 commits into from
Oct 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions example/code.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
from __future__ import annotations

def file_name(): ...
def first_line_number(): ...
def function_name(): ...
def line_number(): ...
34 changes: 34 additions & 0 deletions example/code.zig
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

const std = @import("std");
const py = @import("pydust");

pub fn line_number() u32 {
return py.PyFrame.get().?.lineNumber();
}

pub fn function_name() !py.PyString {
return py.PyFrame.get().?.code().name();
}

pub fn file_name() !py.PyString {
return py.PyFrame.get().?.code().fileName();
}

pub fn first_line_number() !u32 {
return py.PyFrame.get().?.code().firstLineNumber();
}

comptime {
py.rootmodule(@This());
}
2 changes: 2 additions & 0 deletions pydust/src/types.zig
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@
pub usingnamespace @import("types/bool.zig");
pub usingnamespace @import("types/buffer.zig");
pub usingnamespace @import("types/bytes.zig");
pub usingnamespace @import("types/code.zig");
pub usingnamespace @import("types/dict.zig");
pub usingnamespace @import("types/error.zig");
pub usingnamespace @import("types/float.zig");
pub usingnamespace @import("types/frame.zig");
pub usingnamespace @import("types/gil.zig");
pub usingnamespace @import("types/iter.zig");
pub usingnamespace @import("types/list.zig");
Expand Down
45 changes: 45 additions & 0 deletions pydust/src/types/code.zig
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

const std = @import("std");
const py = @import("../pydust.zig");
const PyObjectMixin = @import("./obj.zig").PyObjectMixin;

const ffi = py.ffi;

/// Wrapper for Python PyCode.
/// See: https://docs.python.org/3/c-api/code.html
pub const PyCode = extern struct {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can find a handy reference of the field names in https://docs.python.org/3/library/inspect.html

obj: py.PyObject,

pub inline fn firstLineNumber(self: *const PyCode) !u32 {
const lineNo = try self.obj.getAs(py.PyLong, "co_firstlineno");
defer lineNo.decref();
return lineNo.as(u32);
}

pub inline fn fileName(self: *const PyCode) !py.PyString {
return self.obj.getAs(py.PyString, "co_filename");
}

pub inline fn name(self: *const PyCode) !py.PyString {
return self.obj.getAs(py.PyString, "co_name");
}
};

test "PyCode" {
py.initialize();
defer py.finalize();

const pf = py.PyFrame.get();
try std.testing.expectEqual(@as(?py.PyFrame, null), pf);
}
53 changes: 53 additions & 0 deletions pydust/src/types/frame.zig
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

const std = @import("std");
const py = @import("../pydust.zig");
const PyObjectMixin = @import("./obj.zig").PyObjectMixin;

const ffi = py.ffi;

/// Wrapper for Python PyFrame.
/// See: https://docs.python.org/3/c-api/frame.html
pub const PyFrame = extern struct {
obj: py.PyObject,

pub fn get() ?PyFrame {
const frame = ffi.PyEval_GetFrame();
robert3005 marked this conversation as resolved.
Show resolved Hide resolved
return if (frame) |f| .{ .obj = .{ .py = objPtr(f) } } else null;
}

pub fn code(self: PyFrame) py.PyCode {
const codeObj = ffi.PyFrame_GetCode(framePtr(self.obj.py));
return .{ .obj = .{ .py = @alignCast(@ptrCast(codeObj)) } };
}

pub inline fn lineNumber(self: PyFrame) u32 {
return @intCast(ffi.PyFrame_GetLineNumber(framePtr(self.obj.py)));
}

inline fn framePtr(obj: *ffi.PyObject) *ffi.PyFrameObject {
return @alignCast(@ptrCast(obj));
}

inline fn objPtr(obj: *ffi.PyFrameObject) *ffi.PyObject {
return @alignCast(@ptrCast(obj));
}
};

test "PyFrame" {
py.initialize();
defer py.finalize();

const pf = PyFrame.get();
try std.testing.expectEqual(@as(?PyFrame, null), pf);
}
4 changes: 4 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -103,3 +103,7 @@ root = "example/iterators.zig"
[[tool.pydust.ext_module]]
name = "example.operators"
root = "example/operators.zig"

[[tool.pydust.ext_module]]
name = "example.code"
root = "example/code.zig"
30 changes: 30 additions & 0 deletions test/test_code.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
"""
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
"""

from pathlib import Path

from example import code


def test_line_no():
assert code.line_number() == 21
assert code.first_line_number() == 20


def test_function_name():
assert code.function_name() == "test_function_name"


def test_file_name():
assert Path(code.file_name()).name == "test_code.py"