django-rest-framework/examples/pygments_api/views.py

116 lines
4.0 KiB
Python
Raw Normal View History

from __future__ import with_statement # for python 2.5
2011-01-26 11:58:09 +03:00
from django.conf import settings
from djangorestframework.resources import FormResource
2011-02-19 16:54:55 +03:00
from djangorestframework.response import Response
2011-04-28 22:54:30 +04:00
from djangorestframework.renderers import BaseRenderer
2012-02-22 00:47:55 +04:00
from djangorestframework.reverse import reverse
from djangorestframework.views import View
2011-02-19 16:54:55 +03:00
from djangorestframework import status
2011-01-26 11:58:09 +03:00
from pygments.formatters import HtmlFormatter
from pygments.lexers import get_lexer_by_name
from pygments import highlight
from forms import PygmentsForm
import os
import uuid
import operator
2011-01-26 11:58:09 +03:00
# We need somewhere to store the code snippets that we highlight
2011-01-26 11:58:09 +03:00
HIGHLIGHTED_CODE_DIR = os.path.join(settings.MEDIA_ROOT, 'pygments')
2011-03-23 01:48:59 +03:00
MAX_FILES = 10
2011-12-30 19:51:00 +04:00
if not os.path.exists(HIGHLIGHTED_CODE_DIR):
os.makedirs(HIGHLIGHTED_CODE_DIR)
def list_dir_sorted_by_ctime(dir):
"""
Return a list of files sorted by creation time
"""
filepaths = [os.path.join(dir, file)
for file in os.listdir(dir)
if not file.startswith('.')]
ctimes = [(path, os.path.getctime(path)) for path in filepaths]
ctimes = sorted(ctimes, key=operator.itemgetter(1), reverse=False)
return [filepath for filepath, ctime in ctimes]
def remove_oldest_files(dir, max_files):
"""
Remove the oldest files in a directory 'dir', leaving at most 'max_files' remaining.
We use this to limit the number of resources in the sandbox.
"""
[os.remove(path) for path in list_dir_sorted_by_ctime(dir)[max_files:]]
2011-01-26 11:58:09 +03:00
2011-04-28 22:54:30 +04:00
class HTMLRenderer(BaseRenderer):
"""
Basic renderer which just returns the content without any further serialization.
"""
2011-01-26 11:58:09 +03:00
media_type = 'text/html'
class PygmentsRoot(View):
"""
This example demonstrates a simple RESTful Web API around the awesome pygments library.
This top level resource is used to create highlighted code snippets, and to list all the existing code snippets.
"""
form = PygmentsForm
def get(self, request):
"""
Return a list of all currently existing snippets.
"""
unique_ids = [os.path.split(f)[1] for f in list_dir_sorted_by_ctime(HIGHLIGHTED_CODE_DIR)]
return [reverse('pygments-instance', request, args=[unique_id]) for unique_id in unique_ids]
2011-01-26 11:58:09 +03:00
def post(self, request):
"""
Create a new highlighed snippet and return it's location.
For the purposes of the sandbox example, also ensure we delete the oldest snippets if we have > MAX_FILES.
"""
unique_id = str(uuid.uuid1())
2011-01-26 11:58:09 +03:00
pathname = os.path.join(HIGHLIGHTED_CODE_DIR, unique_id)
lexer = get_lexer_by_name(self.CONTENT['lexer'])
linenos = 'table' if self.CONTENT['linenos'] else False
options = {'title': self.CONTENT['title']} if self.CONTENT['title'] else {}
formatter = HtmlFormatter(style=self.CONTENT['style'], linenos=linenos, full=True, **options)
2011-12-29 17:31:12 +04:00
with open(pathname, 'w') as outfile:
highlight(self.CONTENT['code'], lexer, formatter, outfile)
2011-12-29 17:31:12 +04:00
remove_oldest_files(HIGHLIGHTED_CODE_DIR, MAX_FILES)
return Response(status.HTTP_201_CREATED, headers={'Location': reverse('pygments-instance', request, args=[unique_id])})
2011-01-26 11:58:09 +03:00
class PygmentsInstance(View):
"""
Simply return the stored highlighted HTML file with the correct mime type.
This Resource only renders HTML and uses a standard HTML renderer rather than the renderers.DocumentingHTMLRenderer class.
"""
2011-04-28 22:54:30 +04:00
renderers = (HTMLRenderer,)
2011-01-26 11:58:09 +03:00
def get(self, request, unique_id):
"""
Return the highlighted snippet.
"""
2011-01-26 11:58:09 +03:00
pathname = os.path.join(HIGHLIGHTED_CODE_DIR, unique_id)
if not os.path.exists(pathname):
return Response(status.HTTP_404_NOT_FOUND)
2011-01-26 11:58:09 +03:00
return open(pathname, 'r').read()
def delete(self, request, unique_id):
"""
Delete the highlighted snippet.
"""
2011-01-30 19:51:06 +03:00
pathname = os.path.join(HIGHLIGHTED_CODE_DIR, unique_id)
if not os.path.exists(pathname):
return Response(status.HTTP_404_NOT_FOUND)
2011-01-30 19:51:06 +03:00
return os.remove(pathname)
2011-01-26 11:58:09 +03:00