brotherton-erpnext/erpnext/schools/api.py

357 lines
11 KiB
Python
Raw Normal View History

2016-07-19 08:47:33 +00:00
# -*- coding: utf-8 -*-
# Copyright (c) 2015, Frappe Technologies and contributors
# For license information, please see license.txt
from __future__ import unicode_literals
import frappe
import json
from frappe import _
from frappe.model.mapper import get_mapped_doc
2017-01-09 12:55:43 +00:00
from frappe.utils import flt, cstr
from frappe.email.doctype.email_group.email_group import add_subscribers
2016-07-19 08:47:33 +00:00
def get_course(program):
'''Return list of courses for a particular program
:param program: Program
'''
courses = frappe.db.sql('''select course, course_name from `tabProgram Course` where parent=%s''',
(program), as_dict=1)
return courses
2016-07-19 08:47:33 +00:00
@frappe.whitelist()
def enroll_student(source_name):
"""Creates a Student Record and returns a Program Enrollment.
:param source_name: Student Applicant.
"""
2017-03-15 12:15:02 +00:00
frappe.publish_realtime('enroll_student_progress', {"progress": [1, 4]}, user=frappe.session.user)
2016-07-19 08:47:33 +00:00
student = get_mapped_doc("Student Applicant", source_name,
{"Student Applicant": {
"doctype": "Student",
"field_map": {
"name": "student_applicant"
}
2016-08-22 07:27:09 +00:00
}}, ignore_permissions=True)
2016-07-19 08:47:33 +00:00
student.save()
program_enrollment = frappe.new_doc("Program Enrollment")
program_enrollment.student = student.name
program_enrollment.student_name = student.title
program_enrollment.program = frappe.db.get_value("Student Applicant", source_name, "program")
2017-03-15 12:15:02 +00:00
frappe.publish_realtime('enroll_student_progress', {"progress": [4, 4]}, user=frappe.session.user)
2016-07-19 08:47:33 +00:00
return program_enrollment
2016-07-19 08:47:33 +00:00
@frappe.whitelist()
def check_attendance_records_exist(course_schedule=None, student_group=None, date=None):
"""Check if Attendance Records are made against the specified Course Schedule or Student Group for given date.
2016-07-19 08:47:33 +00:00
:param course_schedule: Course Schedule.
:param student_group: Student Group.
:param date: Date.
2016-07-19 08:47:33 +00:00
"""
if course_schedule:
return frappe.get_list("Student Attendance", filters={"course_schedule": course_schedule})
else:
return frappe.get_list("Student Attendance", filters={"student_group": student_group, "date": date})
2016-07-19 08:47:33 +00:00
2016-07-19 08:47:33 +00:00
@frappe.whitelist()
def mark_attendance(students_present, students_absent, course_schedule=None, student_group=None, date=None):
2016-07-19 08:47:33 +00:00
"""Creates Multiple Attendance Records.
:param students_present: Students Present JSON.
:param students_absent: Students Absent JSON.
:param course_schedule: Course Schedule.
:param student_group: Student Group.
:param date: Date.
2016-07-19 08:47:33 +00:00
"""
2016-07-19 08:47:33 +00:00
present = json.loads(students_present)
absent = json.loads(students_absent)
2016-07-19 08:47:33 +00:00
for d in present:
make_attendance_records(d["student"], d["student_name"], "Present", course_schedule, student_group, date)
2016-07-19 08:47:33 +00:00
for d in absent:
make_attendance_records(d["student"], d["student_name"], "Absent", course_schedule, student_group, date)
2016-07-19 08:47:33 +00:00
frappe.db.commit()
2016-07-19 08:47:33 +00:00
frappe.msgprint(_("Attendance has been marked successfully."))
def make_attendance_records(student, student_name, status, course_schedule=None, student_group=None, date=None):
2017-02-21 06:04:30 +00:00
"""Creates/Update Attendance Record.
2016-07-19 08:47:33 +00:00
:param student: Student.
:param student_name: Student Name.
:param course_schedule: Course Schedule.
:param status: Status (Present/Absent)
"""
2017-02-22 07:35:46 +00:00
student_attendance_list = frappe.get_list("Student Attendance", fields = ['name'], filters = {
2017-02-21 06:04:30 +00:00
"student": student,
"course_schedule": course_schedule,
"student_group": student_group,
2017-02-21 06:04:30 +00:00
"date": date
})
2017-02-22 07:35:46 +00:00
if student_attendance_list:
student_attendance = frappe.get_doc("Student Attendance", student_attendance_list[0])
2017-02-21 06:04:30 +00:00
else:
student_attendance = frappe.new_doc("Student Attendance")
2016-07-19 08:47:33 +00:00
student_attendance.student = student
student_attendance.student_name = student_name
student_attendance.course_schedule = course_schedule
student_attendance.student_group = student_group
student_attendance.date = date
2016-07-19 08:47:33 +00:00
student_attendance.status = status
2017-02-21 06:04:30 +00:00
student_attendance.save()
2016-07-19 08:47:33 +00:00
@frappe.whitelist()
def get_student_guardians(student):
"""Returns List of Guardians of a Student.
:param student: Student.
"""
guardians = frappe.get_list("Student Guardian", fields=["guardian"] ,
filters={"parent": student})
return guardians
2016-07-19 08:47:33 +00:00
@frappe.whitelist()
def get_student_group_students(student_group, include_inactive=0):
2016-07-19 08:47:33 +00:00
"""Returns List of student, student_name in Student Group.
:param student_group: Student Group.
"""
if include_inactive:
students = frappe.get_list("Student Group Student", fields=["student", "student_name"] ,
filters={"parent": student_group}, order_by= "group_roll_number")
else:
students = frappe.get_list("Student Group Student", fields=["student", "student_name"] ,
filters={"parent": student_group, "active": 1}, order_by= "group_roll_number")
2016-07-19 08:47:33 +00:00
return students
2016-07-19 08:47:33 +00:00
@frappe.whitelist()
def get_fee_structure(program, academic_term=None):
"""Returns Fee Structure.
:param program: Program.
:param academic_term: Academic Term.
"""
fee_structure = frappe.db.get_values("Fee Structure", {"program": program,
"academic_term": academic_term}, 'name', as_dict=True)
return fee_structure[0].name if fee_structure else None
2016-07-19 08:47:33 +00:00
@frappe.whitelist()
def get_fee_components(fee_structure):
"""Returns Fee Components.
2016-07-19 08:47:33 +00:00
:param fee_structure: Fee Structure.
"""
if fee_structure:
fs = frappe.get_list("Fee Component", fields=["fees_category", "amount"] , filters={"parent": fee_structure}, order_by= "idx")
2016-07-19 08:47:33 +00:00
return fs
2016-07-19 08:47:33 +00:00
@frappe.whitelist()
2016-09-05 11:25:54 +00:00
def get_fee_schedule(program, student_category=None):
2016-07-19 08:47:33 +00:00
"""Returns Fee Schedule.
:param program: Program.
2016-09-05 11:25:54 +00:00
:param student_category: Student Category
2016-07-19 08:47:33 +00:00
"""
fs = frappe.get_list("Program Fee", fields=["academic_term", "fee_structure", "due_date", "amount"] ,
2016-09-05 11:25:54 +00:00
filters={"parent": program, "student_category": student_category }, order_by= "idx")
2016-07-19 08:47:33 +00:00
return fs
2016-07-19 08:47:33 +00:00
@frappe.whitelist()
def collect_fees(fees, amt):
paid_amount = flt(amt) + flt(frappe.db.get_value("Fees", fees, "paid_amount"))
total_amount = flt(frappe.db.get_value("Fees", fees, "total_amount"))
frappe.db.set_value("Fees", fees, "paid_amount", paid_amount)
frappe.db.set_value("Fees", fees, "outstanding_amount", (total_amount - paid_amount))
return paid_amount
2016-07-19 08:47:33 +00:00
@frappe.whitelist()
def get_course_schedule_events(start, end, filters=None):
"""Returns events for Course Schedule Calendar view rendering.
:param start: Start date-time.
:param end: End date-time.
:param filters: Filters (JSON).
"""
from frappe.desk.calendar import get_event_conditions
conditions = get_event_conditions("Course Schedule", filters)
data = frappe.db.sql("""select name, course,
timestamp(schedule_date, from_time) as from_datetime,
timestamp(schedule_date, to_time) as to_datetime,
room, student_group, 0 as 'allDay'
from `tabCourse Schedule`
where ( schedule_date between %(start)s and %(end)s )
{conditions}""".format(conditions=conditions), {
"start": start,
"end": end
}, as_dict=True, update={"allDay": 0})
return data
2016-12-14 12:19:47 +00:00
2016-12-14 12:19:47 +00:00
@frappe.whitelist()
def get_assessment_criteria(course):
"""Returns Assessmemt Criteria and their Weightage from Course Master.
2016-12-14 12:19:47 +00:00
:param Course: Course
"""
return frappe.get_list("Course Assessment Criteria", \
fields=["assessment_criteria", "weightage"], filters={"parent": course}, order_by= "idx")
2017-01-09 12:55:43 +00:00
2017-01-09 12:55:43 +00:00
@frappe.whitelist()
def get_assessment_students(assessment_plan, student_group):
student_list = get_student_group_students(student_group)
2017-01-09 12:55:43 +00:00
for i, student in enumerate(student_list):
result = get_result(student.student, assessment_plan)
if result:
student_result = {}
for d in result.details:
student_result.update({d.assessment_criteria: [cstr(d.score), d.grade]})
student_result.update({
"total_score": [cstr(result.total_score), result.grade],
"comment": result.comment
})
student.update({
"assessment_details": student_result,
"docstatus": result.docstatus,
"name": result.name
})
2017-01-09 12:55:43 +00:00
else:
student.update({'assessment_details': None})
return student_list
2016-12-14 12:19:47 +00:00
@frappe.whitelist()
2017-01-04 11:30:43 +00:00
def get_assessment_details(assessment_plan):
"""Returns Assessment Criteria and Maximum Score from Assessment Plan Master.
2016-12-14 12:19:47 +00:00
2017-01-04 11:30:43 +00:00
:param Assessment Plan: Assessment Plan
2016-12-14 12:19:47 +00:00
"""
return frappe.get_list("Assessment Plan Criteria", \
fields=["assessment_criteria", "maximum_score", "docstatus"], filters={"parent": assessment_plan}, order_by= "idx")
2016-12-14 12:19:47 +00:00
2017-01-09 12:55:43 +00:00
@frappe.whitelist()
def get_result(student, assessment_plan):
"""Returns Submitted Result of given student for specified Assessment Plan
:param Student: Student
:param Assessment Plan: Assessment Plan
"""
results = frappe.get_all("Assessment Result", filters={"student": student,
"assessment_plan": assessment_plan, "docstatus": ("!=", 2)})
2017-01-09 12:55:43 +00:00
if results:
return frappe.get_doc("Assessment Result", results[0])
else:
return None
2016-12-14 12:19:47 +00:00
2016-12-14 12:19:47 +00:00
@frappe.whitelist()
def get_grade(grading_scale, percentage):
"""Returns Grade based on the Grading Scale and Score.
:param Grading Scale: Grading Scale
:param Percentage: Score Percentage Percentage
"""
grading_scale_intervals = {}
for d in frappe.get_all("Grading Scale Interval", fields=["grade_code", "threshold"], filters={"parent": grading_scale}):
grading_scale_intervals.update({d.threshold:d.grade_code})
2016-12-14 12:19:47 +00:00
intervals = sorted(grading_scale_intervals.keys(), key=float, reverse=True)
for interval in intervals:
if flt(percentage) >= interval:
grade = grading_scale_intervals.get(interval)
break
else:
2017-01-09 12:55:43 +00:00
grade = ""
return grade
2017-01-09 12:55:43 +00:00
@frappe.whitelist()
def mark_assessment_result(assessment_plan, scores):
student_score = json.loads(scores);
assessment_details = []
for criteria in student_score.get("assessment_details"):
assessment_details.append({
"assessment_criteria": criteria,
"score": flt(student_score["assessment_details"][criteria])
2017-01-09 12:55:43 +00:00
})
assessment_result = get_assessment_result_doc(student_score["student"], assessment_plan)
2017-01-09 12:55:43 +00:00
assessment_result.update({
"student": student_score.get("student"),
2017-01-09 12:55:43 +00:00
"assessment_plan": assessment_plan,
"comment": student_score.get("comment"),
"total_score":student_score.get("total_score"),
"details": assessment_details
2017-01-09 12:55:43 +00:00
})
assessment_result.save()
details = {}
for d in assessment_result.details:
details.update({d.assessment_criteria: d.grade})
assessment_result_dict = {
"name": assessment_result.name,
"student": assessment_result.student,
"total_score": assessment_result.total_score,
"grade": assessment_result.grade,
"details": details
}
return assessment_result_dict
@frappe.whitelist()
def submit_assessment_results(assessment_plan, student_group):
total_result = 0
student_list = get_student_group_students(student_group)
for i, student in enumerate(student_list):
doc = get_result(student.student, assessment_plan)
if doc and doc.docstatus==0:
total_result += 1
doc.submit()
return total_result
def get_assessment_result_doc(student, assessment_plan):
assessment_result = frappe.get_all("Assessment Result", filters={"student": student,
"assessment_plan": assessment_plan, "docstatus": ("!=", 2)})
if assessment_result:
doc = frappe.get_doc("Assessment Result", assessment_result[0])
if doc.docstatus == 0:
return doc
elif doc.docstatus == 1:
frappe.msgprint("Result already Submitted")
return None
else:
return frappe.new_doc("Assessment Result")
@frappe.whitelist()
def update_email_group(doctype, name):
if not frappe.db.exists("Email Group", name):
email_group = frappe.new_doc("Email Group")
email_group.title = name
email_group.save()
email_list = []
students = []
if doctype == "Student Group":
students = get_student_group_students(name)
for stud in students:
for guard in get_student_guardians(stud.student):
email = frappe.db.get_value("Guardian", guard.guardian, "email_address")
if email:
email_list.append(email)
2017-02-22 06:23:13 +00:00
add_subscribers(name, email_list)