Script API

Di platform TechMaju, berbagai modul dan perintah Python tersedia untuk digunakan dalam skrip dalam aplikasi. Alat-alat ini penting untuk menyesuaikan dan mengotomatiskan fungsionalitas dalam aplikasi TechMaju Anda tanpa perlu membuat aplikasi berfitur lengkap.

Namun, beberapa perintah dibatasi dalam konteks ini dan fitur yang lebih kompleks harus diimplementasikan dalam aplikasi khusus menggunakan modul Python. Di bawah ini adalah daftar rinci modul dan perintah yang tersedia yang dikategorikan berdasarkan fungsinya.

Pemformatan

Fungsi	Deskripsi	Contoh
`_(Translate)`	Menerjemahkan string	`_("This is translatable")`
`frappe.format`	Memformat nilai berdasarkan tipe datanya	`frappe.format_value(value,dict(fieldtype='Currency'))`
`frappe.date_format`	Format sebagai format tanggal default
`frappe.format_date`	Mengembalikan tanggal sebagai "1 September 2019"

Sesi

Atribut/Fungsi	Deskripsi	Contoh
`frappe.form_dict`	Parameter formulir/permintaan	`frappe.form_dict.name`
`frappe.request`	Objek permintaan
`frappe.response`	Objek respons
`frappe.session.user`	Pengguna saat ini
`frappe.session.csrf_token`	Token CSRF dari sesi saat ini
`frappe.user`	Pengguna saat ini
`frappe.get_fullname`	Mengembalikan nama lengkap pengguna saat ini
`frappe.get_gravatar`	Mendapatkan gambar tampilan pengguna
`frappe.full_name`	Nama lengkap pengguna saat ini

Dokumen (ORM)

Fungsi	Deskripsi	Contoh
`frappe.get_meta`	Dapatkan objek metadata
`frappe.new_doc`	Buat catatan Dokumen baru
`frappe.get_doc`	Dapatkan Dokumen	`frappe.get_doc("User", frappe.session.user)`
`frappe.get_last_doc`	Dapatkan Dokumen terakhir dari DocType tertentu	`frappe.get_last_doc("User", filters={"name": ("like", "%@apple.com")})`
`frappe.get_cached_doc`	Dapatkan Dokumen (atau dari cache)
`frappe.get_mapped_doc`	Dapatkan dokumen yang dipetakan
`frappe.rename_doc`	Ubah nama dokumen
`frappe.delete_doc`	Hapus dokumen
`frappe.get_system_settings`	Dapatkan pengaturan default sistem

Basis Data

Fungsi	Deskripsi	Contoh
`frappe.db.get_list`	Dapatkan daftar catatan yang difilter berdasarkan izin pengguna saat ini	`frappe.db.get_list("Customer")`
`frappe.db.get_all`	Dapatkan daftar semua catatan
`frappe.db.sql`	Jalankan kueri SELECT	`frappe.db.sql("select name from Customer where name like 'm%'")`
`frappe.db.get_value`	Dapatkan nilai dari sebuah catatan	`frappe.db.get_value("User", frappe.session.user, "first_name")`
`frappe.db.get_single_value`	Dapatkan nilai dari dokumen tipe tunggal	`frappe.db.get_single_value("System Settings", "default_currency")`
`frappe.db.get_default`	Dapatkan nilai default
`frappe.db.escape`	Sanitasi nilai untuk kueri basis data
`frappe.db.set_value`	Tetapkan sebuah nilai
`frappe.db.exists`	Memeriksa keberadaan dokumen
`frappe.db.commit`	Izinkan commit eksplisit dalam skrip server	Catatan: Tidak berfungsi dalam skrip server Event DocType.
`frappe.db.rollback`	Izinkan rollback perubahan melalui skrip server	Catatan: Tidak berfungsi dalam skrip server Event DocType.

Pembuat Kueri

Fungsi	Deskripsi	Contoh
`frappe.qb`	API pembuat kueri	`frappe.qb.from_("Task").select("*").run()`

Utilitas

Fungsi	Deskripsi	Contoh
`mantera.exec_script`	Menjalankan Script Function
`run_script`	Jalankan skrip server
`frappe.msgprint`	Tampilkan modal di sisi server	`frappe.msgprint("Hello")`
`frappe.utils`	Metode dalam `frappe.utils`
`frappe.render_template`	Render templat Jinja
`frappe.get_url`	Dapatkan URL situs saat ini
`guess_mimetype`	Mengembalikan mimetypes.guess_type
`html2text`	Enkode HTML sebagai teks (markdown)
`dev_server`	Benar jika dalam mode pengembang
`frappe.log_error`	Hasilkan log kesalahan dengan traceback	`frappe.log_error("Error")`

API

Fungsi	Deskripsi	Contoh
`frappe.make_get_request`	Buat permintaan GET	`frappe.make_get_request('https://example.com')`
`frappe.make_post_request`	Buat permintaan POST	`frappe.make_post_request('https://example.com', data={'username: 'test'})`
`frappe.make_put_request`	Buat permintaan PUT	`frappe.make_put_request('https://example.com', headers={'Auth': 'Bearer xyz'})`
`frappe.make_patch_request`	Buat permintaan PATCH
`frappe.make_delete_request`	Buat permintaan DELETE

Email

Fungsi	Deskripsi	Contoh
`frappe.sendmail`	Kirim email	`frappe.sendmail(recipients=['test@example.com'], sender='sender@example.com', subject='My Subject', message='<p>Hello</p>')`